exa.bee

Class KeyValue

java.lang.Object

exa.bee.KeyValue

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable, java.lang.Cloneable

public class KeyValue
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable, Cloneable

No documentation for this element.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	description
java.lang.String	key
java.util.List<KeyValue>	keyValue
java.lang.String	type
java.lang.String	value

Constructor Summary

Constructors

Constructor and Description
KeyValue()
KeyValue(KeyValue o) Copy constructor
KeyValue(java.util.List<KeyValue> keyValue, java.lang.String key, java.lang.String value, java.lang.String type, java.lang.String description)
KeyValue(java.lang.String key, java.lang.String value)

Method Summary

Modifier and Type	Method and Description
KeyValue	addChild(java.lang.String name) Add a child key with a given name.
void	addChild(java.lang.String name, int value) Add a child key with a given name.
void	addChild(java.lang.String name, long value) Add a child key with a given name.
void	addChild(java.lang.String name, java.lang.String value) Add a child key with a given name.
void	check(boolean deep, java.lang.String errorContext) Checks this KeyValue.
KeyValue	clone() Creates and returns a deep copy of this KeyValue.
java.lang.String	dump() Dump this KeyValue hierarchy
void	dump(java.lang.StringBuilder to, int indent) Dump this KeyValue hierarchy
static KeyValue	fromString(java.lang.String s) String representation of this KeyValue.
KeyValue	getChild(java.lang.String name) Get a child key with a given name.
java.lang.String	getChildValue(java.lang.String name) Get the value of a child key with a given name.
java.lang.String	getChildValue(java.lang.String name, java.lang.String defaultValue) Get the value of a child key with a given name.
java.lang.String	getDescription() -
java.lang.String	getKey() The name of the key
java.util.List<KeyValue>	getKeyValue() -
java.lang.String	getType() -
java.lang.String	getValue() -
KeyValue	makeCopy() Creates and returns a deep copy of this KeyValue.
static KeyValue	newWithChildren(java.util.List<KeyValue> children)
static KeyValue	readFrom(java.io.InputStream is) Read this KeyValue from an XML fragment.
void	setDescription(java.lang.String description) -
void	setKey(java.lang.String key) The name of the key
void	setType(java.lang.String type) -
void	setValue(java.lang.String value) -
java.lang.String	toString() String representation of this KeyValue.
KeyValue	withDescription(java.lang.String description)
KeyValue	withKey(java.lang.String key)
KeyValue	withKeyValue(java.util.Collection<KeyValue> __values)
KeyValue	withKeyValue(KeyValue... __values) -
KeyValue	withType(java.lang.String type)
KeyValue	withValue(java.lang.String value)
void	writeTo(java.io.OutputStream os) Write this KeyValue as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

key

public java.lang.String key

value

public java.lang.String value

type

public java.lang.String type

description

public java.lang.String description

keyValue

public java.util.List<KeyValue> keyValue

Constructor Detail

KeyValue

public KeyValue()

KeyValue

public KeyValue(KeyValue o)

Copy constructor

KeyValue

public KeyValue(java.util.List<KeyValue> keyValue,
                java.lang.String key,
                java.lang.String value,
                java.lang.String type,
                java.lang.String description)

KeyValue

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

Method Detail

setKey

public void setKey(java.lang.String key)

The name of the key

getKey

public java.lang.String getKey()

The name of the key

withKey

public KeyValue withKey(java.lang.String key)

setValue

public void setValue(java.lang.String value)

-

getValue

public java.lang.String getValue()

-

withValue

public KeyValue withValue(java.lang.String value)

setType

public void setType(java.lang.String type)

-

getType

public java.lang.String getType()

-

withType

public KeyValue withType(java.lang.String type)

setDescription

public void setDescription(java.lang.String description)

-

getDescription

public java.lang.String getDescription()

-

withDescription

public KeyValue withDescription(java.lang.String description)

getKeyValue

public java.util.List<KeyValue> getKeyValue()

-

withKeyValue

public KeyValue withKeyValue(KeyValue... __values)

-

withKeyValue

public KeyValue withKeyValue(java.util.Collection<KeyValue> __values)

clone

public KeyValue clone()

Creates and returns a deep copy of this KeyValue.

Overrides:

clone in class java.lang.Object

makeCopy

public KeyValue makeCopy()

Creates and returns a deep copy of this KeyValue.

readFrom

public static KeyValue readFrom(java.io.InputStream is)
                         throws javax.xml.bind.JAXBException

Read this KeyValue from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this KeyValue as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static KeyValue fromString(java.lang.String s)
                           throws javax.xml.bind.JAXBException,
                                  java.io.UnsupportedEncodingException

String representation of this KeyValue.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this KeyValue.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this KeyValue.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException

newWithChildren

public static KeyValue newWithChildren(java.util.List<KeyValue> children)

getChild

public KeyValue getChild(java.lang.String name)

Get a child key with a given name. Dots in the name are interpreted are recursion (a.b.c)

Returns:

null if the child is not found

getChildValue

public java.lang.String getChildValue(java.lang.String name,
                                      java.lang.String defaultValue)

Get the value of a child key with a given name. Dots in the name are interpreted are recursion (a.b.c)

Returns:

defaultValue if the child was not found

getChildValue

public java.lang.String getChildValue(java.lang.String name)
                               throws java.lang.Exception

Get the value of a child key with a given name. Dots in the name are interpreted are recursion (a.b.c)

Throws:

KeyNotFoundException - if the child was not found

java.lang.Exception

addChild

public KeyValue addChild(java.lang.String name)

Add a child key with a given name. Dots in the name are interpreted are recursion (a.b.c)

Returns:

the newly added child

addChild

public void addChild(java.lang.String name,
                     java.lang.String value)

Add a child key with a given name. Dots in the name are interpreted are recursion (a.b.c)

addChild

public void addChild(java.lang.String name,
                     int value)

Add a child key with a given name. Dots in the name are interpreted are recursion (a.b.c)

addChild

public void addChild(java.lang.String name,
                     long value)

Add a child key with a given name. Dots in the name are interpreted are recursion (a.b.c)

dump

public void dump(java.lang.StringBuilder to,
                 int indent)

Dump this KeyValue hierarchy

dump

public java.lang.String dump()

Dump this KeyValue hierarchy