org.eth.cyril.model.model.nodes

Interface ObjectValue

All Superinterfaces:

JsonSerializable, MatchingResolver, Resolver, Value

All Known Subinterfaces:

AbstractingValue, ArrayValue

All Known Implementing Classes:

AbstractingValueImpl, ArrayValueImpl, ObjectValueImpl

public interface ObjectValue
extends Value

An Object value denotes a standard Java object which is not primitive. Arrays are also considered to be objects, but they are considered a special case and have their own extension of ObjectValue: See ArrayValue.

Method Summary

Modifier and Type	Method and Description
default void	addField(java.lang.String name, Value value) Add a field with the given name and value to this ObjectValue instance.
void	addFieldWithDisplayName(java.lang.String name, Value value, java.lang.String displayName) Add a field with the given name and value to this ObjectValue instance.
default void	removeField(java.lang.String name, Value value) Removes the field with the given name and Value instance.
void	replaceField(java.lang.String name, Value previous, Value newField) Replaces the field with the given name and Value instance with the given new field.

Methods inherited from interface org.eth.cyril.model.model.nodes.Value

addParent, field, fieldFor, fields, id, parent, parentFor, parents, removeParent, replaceParent, setValueString, typeEquals, typeName, valueString

Methods inherited from interface org.eth.cyril.model.constraintlanguage.MatchingResolver

matches

Methods inherited from interface org.eth.cyril.model.constraintlanguage.Resolver

canResolve, getResolvableNames, resolve

Methods inherited from interface org.eth.cyril.util.serialization.JsonSerializable

fromJson, toJson

Method Detail

addField

default void addField(java.lang.String name,
                      Value value)

Add a field with the given name and value to this ObjectValue instance. The field can be of any Value type.

Parameters:

name - The name of the new field to be added.

value - The value of the new field to be added.

addFieldWithDisplayName

void addFieldWithDisplayName(java.lang.String name,
                             Value value,
                             java.lang.String displayName)

Add a field with the given name and value to this ObjectValue instance. The field can be of any Value type. When displaying this field, the given displayName should be used.

Parameters:

name - The name of the new field to be added.

value - The value of the new field to be added.

displayName - The name of the new field to use for displaying the field.

replaceField

void replaceField(java.lang.String name,
                  Value previous,
                  Value newField)

Replaces the field with the given name and Value instance with the given new field. If the old field doesn't exist, the behavior is undefined. It may either add the new field or not. Setting the newField to null removes the field with the given name and value.

Parameters:

name - The name of the field to replace.

previous - The previous field which should be replaced.

newField - The new field which should replace the previous parent. Set it to null to remove the field with the given name and value.

removeField

default void removeField(java.lang.String name,
                         Value value)

Removes the field with the given name and Value instance. The default implementation calls replaceField(String, Value, Value), setting the third argument to be null.

Parameters:

name - The name of the field to remove.

value - The value of the field to remove.