public abstract class StructuredFieldValue extends CompositeFieldValue
FieldValue.RecursiveIteratorHandler
Modifier and Type | Field and Description |
---|---|
static int |
classId |
Modifier | Constructor and Description |
---|---|
protected |
StructuredFieldValue(StructuredDataType type) |
Modifier and Type | Method and Description |
---|---|
abstract void |
clear() |
protected abstract void |
doSetFieldValue(Field field,
FieldValue value) |
StructuredDataType |
getDataType() |
abstract Field |
getField(String fieldName)
Returns the named field object, or null if that field does not exist.
|
abstract int |
getFieldCount() |
abstract FieldValue |
getFieldValue(Field field)
Returns the value of the given field.
|
FieldValue |
getFieldValue(String fieldName)
Convenience method to return the value of a named field.
|
protected boolean |
isGenerated()
Generated Document subclasses should override this and return true.
|
FieldPathIteratorHandler.ModificationStatus |
iterateNested(FieldPath fieldPath,
int pos,
FieldPathIteratorHandler handler)
Iterates through the document using the given fieldpath, calling callbacks in the given iterator
handler.
|
abstract Iterator<Map.Entry<Field,FieldValue>> |
iterator() |
abstract FieldValue |
removeFieldValue(Field field)
Removes and returns a field value.
|
FieldValue |
removeFieldValue(String fieldName)
Convenience method to remove the value of a named field.
|
FieldValue |
setFieldValue(Field field,
Byte value) |
FieldValue |
setFieldValue(Field field,
Double value) |
FieldValue |
setFieldValue(Field field,
FieldValue value)
Sets the value of the given field.
|
FieldValue |
setFieldValue(Field field,
Integer value) |
FieldValue |
setFieldValue(Field field,
Long value) |
FieldValue |
setFieldValue(Field field,
String value) |
FieldValue |
setFieldValue(String field,
Byte value) |
FieldValue |
setFieldValue(String field,
Double value) |
FieldValue |
setFieldValue(String fieldName,
FieldValue value)
Convenience method to set the value of a named field.
|
FieldValue |
setFieldValue(String field,
Integer value) |
FieldValue |
setFieldValue(String field,
Long value) |
FieldValue |
setFieldValue(String field,
String value) |
equals, hashCode, setDataType
assign, checkAssign, clone, compareTo, create, deserialize, deserialize, getRecursiveValue, getRecursiveValue, getWrappedValue, onDeserialize, onSerialize, printXml, serialize, serialize, toXml
protected StructuredFieldValue(StructuredDataType type)
public StructuredDataType getDataType()
getDataType
in class CompositeFieldValue
public abstract Field getField(String fieldName)
fieldName
- The name of the field to return.public abstract FieldValue getFieldValue(Field field)
field
- The field whose value to return.public FieldValue getFieldValue(String fieldName)
getField(String)
,
and using the returned value to call getFieldValue(Field)
. If the named field does not exist, this
method returns null.fieldName
- The name of the field whose value to return.public FieldValue setFieldValue(Field field, FieldValue value)
field.getDataType().getValueClass().isAssignableFrom(value.getClass())must be true.
field
- The field whose value to set.value
- The value to set.IllegalArgumentException
- If the value is not compatible with the field.protected abstract void doSetFieldValue(Field field, FieldValue value)
public FieldValue setFieldValue(String fieldName, FieldValue value)
getField(String)
, and
using the returned value to call setFieldValue(Field, FieldValue)
. If the named field does not exist,
this method returns null.fieldName
- The name of the field whose value to set.value
- The value to set.public final FieldValue setFieldValue(Field field, String value)
public final FieldValue setFieldValue(Field field, Double value)
public final FieldValue setFieldValue(Field field, Integer value)
public final FieldValue setFieldValue(Field field, Long value)
public final FieldValue setFieldValue(Field field, Byte value)
public final FieldValue setFieldValue(String field, String value)
public final FieldValue setFieldValue(String field, Double value)
public final FieldValue setFieldValue(String field, Integer value)
public final FieldValue setFieldValue(String field, Long value)
public final FieldValue setFieldValue(String field, Byte value)
public abstract FieldValue removeFieldValue(Field field)
field
- The field whose value to remove.public FieldValue removeFieldValue(String fieldName)
getField(String)
,
and using the returned value to call removeFieldValue(Field)
. If the named field does not exist, this
method returns null.fieldName
- The name of the field whose value to remove.public abstract void clear()
clear
in class FieldValue
public abstract int getFieldCount()
public abstract Iterator<Map.Entry<Field,FieldValue>> iterator()
public FieldPathIteratorHandler.ModificationStatus iterateNested(FieldPath fieldPath, int pos, FieldPathIteratorHandler handler)
FieldValue
iterateNested
in class FieldValue
protected boolean isGenerated()
Copyright © 2017. All rights reserved.