wt.tools.resource
Class ResourceEntry

java.lang.Object
  wt.tools.resource.ResourceEntry

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

EnumResourceEntry

public class ResourceEntry

extends Object

implements Cloneable

An entry for a Resource.

Supported API: false

Extendable: false

Field Summary

private String[]	argComments
private String	category
private static String	CLASSNAME
private String	comment
private String	constant
private boolean	customizable
private boolean	deprecated
private String	key
private static Vector	knownAttributes
private ResourceValue	owningValue
private static String	RESOURCE
protected static String	SEP_CHAR

Constructor Summary

ResourceEntry()

Method Summary

private void	categoryValidate(String a_Category)
Object	clone() Supported API: false
private void	commentValidate(String a_Comment)
private void	constantValidate(String a_Constant)
static boolean	equal(Object obj1, Object obj2)
boolean	equals(Object obj)
protected static boolean	equivalent(String obj1, String obj2)
protected String	get(Dictionary source, String attribute)
String[]	getArgComments() Gets the value of the attribute: argComments; Descriptions of the arguments that may be embedded in the entry's value (message).
String	getCategory() Gets the value of the attribute: category; Non-localizable category of the entry.
String	getComment() Gets the value of the attribute: comment; Non-localizable description of the entry.
String	getConstant() Gets the value of the attribute: constant; The (optional) constant field name for the entry.
protected Dictionary	getExtraProperties(Dictionary source)
String	getKey() Gets the value of the attribute: key; Internal key for the entry.
protected ResourceValue	getOwningValue() Gets the object for the association that plays role: owningValue.
protected void	initialize(String a_Key, ResourceValue owner) Supported API: false
boolean	isCustomizable() Gets the value of the attribute: customizable; Specifies if this resource entry can be customized.
boolean	isDeprecated() Gets the value of the attribute: deprecated; Specifies if this resource entry is deprecated.
private void	keyValidate(String a_Key)
protected void	load(Dictionary source, String owner) Load the state of this instance from the source.
(package private) static ResourceEntry	newResourceEntry(String a_Key, ResourceValue owner) Supported API: false
void	setArgComments(String[] a_ArgComments) Sets the value of the attribute: argComments; Descriptions of the arguments that may be embedded in the entry's value (message).
void	setCategory(String a_Category) Sets the value of the attribute: category; Non-localizable category of the entry.
void	setComment(String a_Comment) Sets the value of the attribute: comment; Non-localizable description of the entry.
void	setConstant(String a_Constant) Sets the value of the attribute: constant; The (optional) constant field name for the entry.
void	setCustomizable(boolean a_Customizable) Sets the value of the attribute: customizable; Specifies if this resource entry can be customized.
void	setDeprecated(boolean a_Deprecated) Sets the value of the attribute: deprecated; Specifies if this resource entry is deprecated.
protected void	setKey(String a_Key) Sets the value of the attribute: key; Internal key for the entry.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

key

private String key

category

private String category

comment

private String comment

argComments

private String[] argComments

constant

private String constant

customizable

private boolean customizable

deprecated

private boolean deprecated

owningValue

private ResourceValue owningValue

SEP_CHAR

protected static final String SEP_CHAR

See Also:

Constant Field Values

knownAttributes

private static final Vector knownAttributes

Constructor Detail

ResourceEntry

public ResourceEntry()

Method Detail

getKey

public String getKey()

Gets the value of the attribute: key; Internal key for the entry.

Supported API: false

Returns:

String

setKey

protected void setKey(String a_Key)
               throws WTPropertyVetoException

Sets the value of the attribute: key; Internal key for the entry.

Supported API: false

Parameters:

a_Key -

Throws:

WTPropertyVetoException

keyValidate

private void keyValidate(String a_Key)
                  throws WTPropertyVetoException

Parameters:

a_Key -

Throws:

WTPropertyVetoException

getCategory

public String getCategory()

Gets the value of the attribute: category; Non-localizable category of the entry.

Supported API: false

Returns:

String

setCategory

public void setCategory(String a_Category)
                 throws WTPropertyVetoException

Sets the value of the attribute: category; Non-localizable category of the entry.

Supported API: false

Parameters:

a_Category -

Throws:

WTPropertyVetoException

categoryValidate

private void categoryValidate(String a_Category)
                       throws WTPropertyVetoException

Parameters:

a_Category -

Throws:

WTPropertyVetoException

getComment

public String getComment()

Gets the value of the attribute: comment; Non-localizable description of the entry.

Supported API: false

Returns:

String

setComment

public void setComment(String a_Comment)
                throws WTPropertyVetoException

Sets the value of the attribute: comment; Non-localizable description of the entry.

Supported API: false

Parameters:

a_Comment -

Throws:

WTPropertyVetoException

commentValidate

private void commentValidate(String a_Comment)
                      throws WTPropertyVetoException

Parameters:

a_Comment -

Throws:

WTPropertyVetoException

getArgComments

public String[] getArgComments()

Gets the value of the attribute: argComments; Descriptions of the arguments that may be embedded in the entry's value (message).

Supported API: false

Returns:

String[]

setArgComments

public void setArgComments(String[] a_ArgComments)
                    throws WTPropertyVetoException

Sets the value of the attribute: argComments; Descriptions of the arguments that may be embedded in the entry's value (message).

Supported API: false

Parameters:

a_ArgComments -

Throws:

WTPropertyVetoException

getConstant

public String getConstant()

Gets the value of the attribute: constant; The (optional) constant field name for the entry.

Supported API: false

Returns:

String

setConstant

public void setConstant(String a_Constant)
                 throws WTPropertyVetoException

Sets the value of the attribute: constant; The (optional) constant field name for the entry.

Supported API: false

Parameters:

a_Constant -

Throws:

WTPropertyVetoException

constantValidate

private void constantValidate(String a_Constant)
                       throws WTPropertyVetoException

Parameters:

a_Constant -

Throws:

WTPropertyVetoException

isCustomizable

public boolean isCustomizable()

Gets the value of the attribute: customizable; Specifies if this resource entry can be customized.

Supported API: false

Returns:

boolean

setCustomizable

public void setCustomizable(boolean a_Customizable)
                     throws WTPropertyVetoException

Sets the value of the attribute: customizable; Specifies if this resource entry can be customized.

Supported API: false

Parameters:

a_Customizable -

Throws:

WTPropertyVetoException

isDeprecated

public boolean isDeprecated()

Gets the value of the attribute: deprecated; Specifies if this resource entry is deprecated.

Supported API: false

Returns:

boolean

setDeprecated

public void setDeprecated(boolean a_Deprecated)

Sets the value of the attribute: deprecated; Specifies if this resource entry is deprecated.

Supported API: false

Parameters:

a_Deprecated -

getOwningValue

protected ResourceValue getOwningValue()

Gets the object for the association that plays role: owningValue.

Supported API: false

Returns:

ResourceValue

newResourceEntry

static ResourceEntry newResourceEntry(String a_Key,
                                      ResourceValue owner)
                               throws WTPropertyVetoException

Supported API: false

Parameters:

a_Key -

owner -

Returns:

ResourceEntry

Throws:

WTPropertyVetoException

initialize

protected void initialize(String a_Key,
                          ResourceValue owner)
                   throws WTPropertyVetoException

Supported API: false

Parameters:

a_Key -

owner -

Throws:

WTPropertyVetoException

load

protected void load(Dictionary source,
                    String owner)
             throws WTPropertyVetoException

Load the state of this instance from the source.

Supported API: false

Parameters:

source -

owner -

Throws:

WTPropertyVetoException

clone

public Object clone()

Supported API: false

Returns:

Object

get

protected String get(Dictionary source,
                     String attribute)

getExtraProperties

protected Dictionary getExtraProperties(Dictionary source)

equals

public boolean equals(Object obj)

equal

public static boolean equal(Object obj1,
                            Object obj2)

equivalent

protected static boolean equivalent(String obj1,
                                    String obj2)

toString

public String toString()