com.plumtree.remote.crawler
Class ContainerMetaData

java.lang.Object
  com.plumtree.remote.crawler.ContainerMetaData

public class ContainerMetaData

extends java.lang.Object

Stores metadata information about the Container object.

Constructor Summary

ContainerMetaData()
Default constructor.

ContainerMetaData(NamedValue[] nvArray)
Valued constructor.

Method Summary

void	fromArray(NamedValue[] nvArray) Overwrites the content of this map with the data from the input NamedValue array.
java.lang.Object	get(java.lang.Object key, java.lang.Object def) Returns an object mapped to a key or uses a default object if no value is found.
java.lang.String	get(java.lang.String key) Gets the value for the input key.
java.lang.String	getDescription() Gets the textual description of this container.
java.lang.String	getName() Gets the name of this container.
java.lang.String	put(java.lang.String key, java.lang.String value) Inserts a key/value mapping into the map.
java.lang.String	setDescription(java.lang.String value) Sets the textual description of this container.
java.lang.String	setName(java.lang.String value) Sets the name of this container.
NamedValue[]	toArray() Returns the contents of this map as a NamedValue array
java.lang.String	toString() Returns a String representation of the mapping for debugging.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ContainerMetaData

public ContainerMetaData()

Default constructor.

ContainerMetaData

public ContainerMetaData(NamedValue[] nvArray)

Valued constructor.

Parameters:

nvArray - a NamedValue array to use as data

Method Detail

getName

public java.lang.String getName()

Gets the name of this container.

Returns:

the container name

setName

public java.lang.String setName(java.lang.String value)

Sets the name of this container.

Parameters:

value - the new name

Returns:

the new name

getDescription

public java.lang.String getDescription()

Gets the textual description of this container.

Returns:

the container description

setDescription

public java.lang.String setDescription(java.lang.String value)

Sets the textual description of this container.

Parameters:

value - the new description

Returns:

the new description

get

public java.lang.Object get(java.lang.Object key,
                            java.lang.Object def)

Returns an object mapped to a key or uses a default object if no value is found.

Parameters:

key - the key mapped to the object to be returned

def - the default object value

Returns:

the object mapped to the key or the default if no object is mapped

get

public java.lang.String get(java.lang.String key)

Gets the value for the input key.

Parameters:

key - the key

Returns:

the value mapped to the key

put

public java.lang.String put(java.lang.String key,
                            java.lang.String value)

Inserts a key/value mapping into the map.

Parameters:

key - the key string to be added

value - the value string to be mapped to the key

Returns:

the new mapping

fromArray

public void fromArray(NamedValue[] nvArray)

Overwrites the content of this map with the data from the input NamedValue array.

Parameters:

nvArray - the NamedValue array containing the new data

toArray

public NamedValue[] toArray()

Returns the contents of this map as a NamedValue array

Returns:

the container metadata as a NamedValue array

toString

public java.lang.String toString()

Returns a String representation of the mapping for debugging.