oracle.ide.resourcebundle
Class ResourceBundleKey

java.lang.Object
  oracle.ide.resourcebundle.ResourceBundleKey

public final class ResourceBundleKey
extends java.lang.Object

ResourceBundleKey encapsulates an entry in a resource bundle. It is used by the ResourceBundleKeyChooser to return information back to it's clients.

Constructor Summary

ResourceBundleKey()

ResourceBundleKey(NodeResourceBundle bundle, java.lang.String key, java.lang.String text, java.util.Map<java.lang.String,java.lang.String> metadata)

ResourceBundleKey(java.lang.String bundleId, java.lang.String key, java.lang.String text, java.util.Map<java.lang.String,java.lang.String> metadata, ResourceBundleConstants.BundleTypes type, java.lang.String extension)
Constructor

Method Summary

java.lang.String	getBundleId() Gets the fully-qualified name that represents the resource bundle.
java.lang.String	getExtension() Gets the extension of the file used to store the data
java.lang.String	getKey() Gets the key from the resource bundle
java.util.Map<java.lang.String,java.lang.String>	getMetadata() Gets the metdata from the resource bundle
java.lang.String	getText() Gets the text from the resource bundle or just returns the passed-in text
ResourceBundleConstants.BundleTypes	getType() Gets the type of resource bundle
void	setBundleId(java.lang.String bundleId) Sets the bundle id
void	setExtension(java.lang.String extension) Sets the extension of the file used to store the data
void	setKey(java.lang.String key) Sets the key
void	setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata) Sets the metadata
void	setText(java.lang.String text) Sets the text
void	setType(ResourceBundleConstants.BundleTypes type) Sets the type of resource bundle

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceBundleKey

public ResourceBundleKey()

ResourceBundleKey

public ResourceBundleKey(NodeResourceBundle bundle,
                         java.lang.String key,
                         java.lang.String text,
                         java.util.Map<java.lang.String,java.lang.String> metadata)

ResourceBundleKey

public ResourceBundleKey(java.lang.String bundleId,
                         java.lang.String key,
                         java.lang.String text,
                         java.util.Map<java.lang.String,java.lang.String> metadata,
                         ResourceBundleConstants.BundleTypes type,
                         java.lang.String extension)

Constructor

Parameters:

bundleId - a fully-qualified name that represents the resource bundle

key - the key in the resource bundle. Will be null if the option to use resource bundle synchronization is turned off.

text - the text from the resource bundle

metadata - the metadata from the resource bundle. Will be null if the option to use resource bundle synchronization is turned off or if there is not metadata for the entry.

type - the type of the resource bundle

extension - the extension of the file used to store the key (may be null)

Method Detail

getBundleId

public java.lang.String getBundleId()

Gets the fully-qualified name that represents the resource bundle.

Returns:

the fully-qualified name that represents the resource bundle. Will be null if the option to use resource bundle synchronization is turned off.

setBundleId

public void setBundleId(java.lang.String bundleId)

Sets the bundle id

Parameters:

bundleId -

getKey

public java.lang.String getKey()

Gets the key from the resource bundle

Returns:

the key from the resource bundle. Will be null if the option to use resource bundle synchronization is turned off.

setKey

public void setKey(java.lang.String key)

Sets the key

Parameters:

key -

getText

public java.lang.String getText()

Gets the text from the resource bundle or just returns the passed-in text

Returns:

the text from the resource bundle or the passed-in text when the option to use resource bundle synchronization is turned off.

setText

public void setText(java.lang.String text)

Sets the text

Parameters:

text -

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

Gets the metdata from the resource bundle

Returns:

the metadata from the resource bundle. Will be null if the option to use resource bundle synchronization is turned off.

setMetadata

public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)

Sets the metadata

Parameters:

metadata -

getType

public ResourceBundleConstants.BundleTypes getType()

Gets the type of resource bundle

Returns:

type of the resource bundle

setType

public void setType(ResourceBundleConstants.BundleTypes type)

Sets the type of resource bundle

Parameters:

type - the type of the resource bundle

getExtension

public java.lang.String getExtension()

Gets the extension of the file used to store the data

Returns:

the extension of the file used to store the data. May be null

setExtension

public void setExtension(java.lang.String extension)

Sets the extension of the file used to store the data

Parameters:

extension - the extension of the file used to store the data