com.ibm.etools.iseries.edit.preferences.templates
Class ISeriesTemplate

java.lang.Object
  com.ibm.etools.iseries.edit.preferences.templates.ISeriesTemplate

public class ISeriesTemplate
extends Object

A template consiting of a name and a pattern.

Field Summary

static String

Copyright

Constructor Summary

ISeriesTemplate()
Creates an empty template.

ISeriesTemplate(ISeriesTemplate template)
Creates a copy of a template.

ISeriesTemplate(String name, String description, String contextTypeName, String pattern)
Creates a template.

Method Summary

boolean	equals(Object object)
String	getContextTypeName() Returns the name of the context type in which the template can be applied.
String	getDescription() Returns the description of the template.
String	getName() Returns the name of the template.
String	getPattern() Returns the template pattern.
int	hashCode()
boolean	isEnabled() Returns true if template is enabled, false otherwise.
boolean	matches(String prefix, String contextTypeName) Returns true if template matches the prefix and context, false otherwise.
void	setContext(String contextTypeName) Sets the name of the context type in which the template can be applied.
void	setDescription(String description) Sets the description of the template.
void	setEnabled(boolean enable) Sets the enable state of the template.
void	setName(String name) Sets the name of the template.
void	setPattern(String pattern) Sets the pattern of the template.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

Copyright

public static final String Copyright

See Also:

Constant Field Values

Constructor Detail

ISeriesTemplate

public ISeriesTemplate()

Creates an empty template.

ISeriesTemplate

public ISeriesTemplate(ISeriesTemplate template)

Creates a copy of a template.

ISeriesTemplate

public ISeriesTemplate(String name,
                       String description,
                       String contextTypeName,
                       String pattern)

Creates a template.

Parameters:

name - the name of the template.

description - the description of the template.

contextTypeName - the name of the context type in which the template can be applied.

pattern - the template pattern.

Method Detail

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setDescription

public void setDescription(String description)

Sets the description of the template.

getDescription

public String getDescription()

Returns the description of the template.

setContext

public void setContext(String contextTypeName)

Sets the name of the context type in which the template can be applied.

getContextTypeName

public String getContextTypeName()

Returns the name of the context type in which the template can be applied.

setName

public void setName(String name)

Sets the name of the template.

getName

public String getName()

Returns the name of the template.

setPattern

public void setPattern(String pattern)

Sets the pattern of the template.

getPattern

public String getPattern()

Returns the template pattern.

setEnabled

public void setEnabled(boolean enable)

Sets the enable state of the template.

isEnabled

public boolean isEnabled()

Returns true if template is enabled, false otherwise.

matches

public boolean matches(String prefix,
                       String contextTypeName)

Returns true if template matches the prefix and context, false otherwise.