|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.simantics.databoard.util.Bean
public class Bean
Bean is a class with public fields or public get/setters. This support class adds the following services sub-classes: toString #toString() JSON #print() / #parse() Hash-Equals #hashCode() / #equals() Comparable #compareTo() Serialization #serialize()/#deserialize(), #readObject()/#writeObject(), #readFile()/#writeFile() Cloning #clone() / #readFrom() Initialization #init() / #setToDefault() / #setToRandom() Bean class must be compatible with databoard's type system. To use this class, extend it. See BeanExample for example.
Nested Class Summary | |
---|---|
static class |
Bean.Id
In this version of the bean, the hash/equals compares to identifiers. |
Method Summary | |
---|---|
void |
assertIsValid()
|
Bean |
clone()
|
int |
compareTo(Bean o)
|
void |
deserialize(byte[] data)
Deserialize the object from a byte array |
boolean |
equalContents(java.lang.Object obj)
|
boolean |
equals(java.lang.Object obj)
Compare to another bean of same datatype. |
RecordBinding |
getBinding()
Return datatype binding to this class. |
java.lang.Object |
getField(java.lang.String fieldName)
Get value of a field |
java.lang.Object |
getField(java.lang.String fieldName,
Binding binding)
Get value of a field |
Binding |
getFieldBinding(java.lang.String fieldName)
Get binding of a field |
java.lang.Object |
getFieldUnchecked(java.lang.String fieldName)
Get value of a field |
java.lang.Object |
getIdentifier()
Get identifier of the object. |
Binding |
getIdentifierBinding()
Get identifier binding. |
boolean |
hasField(java.lang.String fieldName)
|
int |
hashCode()
|
void |
init()
Set default value to any null field that is not optional. |
void |
parse(java.lang.String str)
Read the contents from JSON String |
java.lang.String |
print()
Print the value to JSON format |
void |
print(java.lang.Appendable out)
Print the value in JSON format |
java.lang.String |
printLine()
Print the value to JSON format |
void |
readAvailableFields(Bean other)
|
void |
readFile(java.io.File file)
|
void |
readFrom(Bean other)
Read all field values from another object. |
void |
readObject(java.io.ObjectInputStream in)
|
byte[] |
serialize()
Serialize the object to a byte array |
void |
setField(java.lang.String fieldName,
Binding fieldBinding,
java.lang.Object field)
|
void |
setToDefault()
Sets all fields to default values. |
void |
setToRandom(java.util.Random random)
Sets all fields with random values |
java.lang.String |
toString()
Print the object as string |
void |
writeFile(java.io.File file)
|
void |
writeObject(java.io.ObjectOutputStream out)
|
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public RecordBinding getBinding()
public void readFrom(Bean other)
other
- public void readAvailableFields(Bean other)
public void init()
public void setToDefault()
public void setToRandom(java.util.Random random)
public int hashCode()
hashCode
in class java.lang.Object
public Bean clone()
clone
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public boolean equalContents(java.lang.Object obj)
public int compareTo(Bean o)
compareTo
in interface java.lang.Comparable<Bean>
public java.lang.String toString()
toString
in class java.lang.Object
public void print(java.lang.Appendable out) throws java.io.IOException
out
-
java.io.IOException
public java.lang.String print() throws java.io.IOException
java.io.IOException
public java.lang.String printLine() throws java.io.IOException
java.io.IOException
public void parse(java.lang.String str) throws DataTypeSyntaxError
str
-
DataTypeSyntaxError
public void readObject(java.io.ObjectInputStream in) throws java.lang.ClassNotFoundException, java.io.IOException
java.lang.ClassNotFoundException
java.io.IOException
public void writeObject(java.io.ObjectOutputStream out) throws java.io.IOException
java.io.IOException
public byte[] serialize() throws java.io.IOException
java.io.IOException
public void deserialize(byte[] data) throws java.io.IOException
data
-
java.io.IOException
public void readFile(java.io.File file) throws java.io.IOException
java.io.IOException
public void writeFile(java.io.File file) throws java.io.IOException
java.io.IOException
public void assertIsValid() throws BindingException
BindingException
public void setField(java.lang.String fieldName, Binding fieldBinding, java.lang.Object field) throws BindingException
BindingException
public boolean hasField(java.lang.String fieldName) throws BindingException
BindingException
public Binding getFieldBinding(java.lang.String fieldName) throws BindingException
fieldName
-
BindingException
public java.lang.Object getField(java.lang.String fieldName) throws BindingException
fieldName
-
BindingException
public java.lang.Object getField(java.lang.String fieldName, Binding binding) throws BindingException
fieldName
- binding
- requested binding
BindingException
public java.lang.Object getFieldUnchecked(java.lang.String fieldName) throws RuntimeBindingException
fieldName
-
RuntimeBindingException
public Binding getIdentifierBinding() throws BindingException
BindingException
- there is no identifierpublic java.lang.Object getIdentifier() throws BindingException
BindingException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |