ValueObject (Java Tool 1.13.0 API)

java.lang.Object
- org.osgl.util.ValueObject

All Implemented Interfaces:

Serializable
```
public class ValueObject
extends Object
implements Serializable
```
A ValueObject encapsulate data of simple types in common Java application.
Simple type here refers to
- Primary types
- String
- Enum
- Types with ValueObject.Codec registered
ValueObject is immutable
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ValueObject.Codec<T>

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ValueObject.Codec<T>`

Constructor Summary

Constructors
Constructor and Description
`ValueObject()`
`ValueObject(boolean b)`
`ValueObject(byte b)`
`ValueObject(char c)`
`ValueObject(CharSequence s)`
`ValueObject(double d)`
`ValueObject(Enum e)`
`ValueObject(float f)`
`ValueObject(int i)`
`ValueObject(long l)`
`ValueObject(Object o)`
`ValueObject(short s)`
`ValueObject(String s)`
`ValueObject(ValueObject copy)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`booleanValue()`
`byte`	`byteValue()`
`char`	`charValue()`
`static <T> T`	`decode(String string, Class<T> targetType)` Decode a object instance from a string with given target object type
`double`	`doubleValue()`
`static String`	`encode(Object o)` Encode a object into a String
`<T extends Enum> T`	`enumValue()`
`boolean`	`equals(Object obj)`
`float`	`floatValue()`
`int`	`hashCode()`
`int`	`intValue()`
`boolean`	`isUDF()`
`long`	`longValue()`
`static ValueObject`	`of(Object o)`
`static void`	`register(ValueObject.Codec codec)`
`short`	`shortValue()`
`String`	`stringValue()`
`String`	`toJSONString()`
`String`	`toString()`
`static void`	`unregister(ValueObject.Codec codec)`
`<T> T`	`value()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ValueObject
```
public ValueObject()
```

ValueObject
```
public ValueObject(boolean b)
```

ValueObject
```
public ValueObject(byte b)
```

ValueObject
```
public ValueObject(char c)
```

ValueObject
```
public ValueObject(short s)
```

ValueObject
```
public ValueObject(int i)
```

ValueObject
```
public ValueObject(float f)
```

ValueObject
```
public ValueObject(long l)
```

ValueObject
```
public ValueObject(double d)
```

ValueObject
```
public ValueObject(String s)
```

ValueObject
```
public ValueObject(CharSequence s)
```

ValueObject
```
public ValueObject(Enum e)
```

ValueObject
```
public ValueObject(Object o)
```

ValueObject
```
public ValueObject(ValueObject copy)
```

Method Detail

booleanValue
```
public boolean booleanValue()
```

byteValue
```
public byte byteValue()
```

charValue
```
public char charValue()
```

shortValue
```
public short shortValue()
```

intValue
```
public int intValue()
```

floatValue
```
public float floatValue()
```

longValue
```
public long longValue()
```

doubleValue
```
public double doubleValue()
```

stringValue
```
public String stringValue()
```

enumValue

public <T extends Enum> T enumValue()

value
```
public <T> T value()
```

isUDF
```
public boolean isUDF()
```

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

toJSONString
```
public String toJSONString()
```

register

public static void register(ValueObject.Codec codec)

unregister

public static void unregister(ValueObject.Codec codec)

decode
```
public static <T> T decode(String string,
                           Class<T> targetType)
```
Decode a object instance from a string with given target object type

Type Parameters:

T - the generic type of the instance

Parameters:

string - the string encoded the value of the instance

targetType - the class of the instance decoded from the string

Returns:

the instance decoded

encode
```
public static String encode(Object o)
```
Encode a object into a String

Parameters:

o - the object to be encoded

Returns:

the encoded string representation of the object

Throws:

IllegalArgumentException - when object is a UDF type and Codec is not registered

of

public static ValueObject of(Object o)

Class ValueObject

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ValueObject

ValueObject

ValueObject

ValueObject

ValueObject

ValueObject

ValueObject

ValueObject

ValueObject

ValueObject

ValueObject

ValueObject

ValueObject

ValueObject

Method Detail

booleanValue

byteValue

charValue

shortValue

intValue

floatValue

longValue

doubleValue

stringValue

enumValue

value

isUDF

hashCode

equals

toString

toJSONString

register

unregister

decode

encode

of