Package org.bedework.jsforj.model.values

Interface JSPatchObject

All Superinterfaces:

JSValue

All Known Subinterfaces:

JSOverride

All Known Implementing Classes:

JSOverrideImpl, JSPatchObjectImpl

public interface JSPatchObject
extends JSValue

User: mike Date: 4/21/20 Time: 13:45

Method Summary

Modifier and Type	Method	Description
<T extends JSValue> JSProperty<T>	newOverrideProperty(com.fasterxml.jackson.core.type.TypeReference<T> typeRef, String type, String... names)	Create a property of the given type.
void	setNull(String... name)	Sets the named property to have a value of null.
JSProperty<?>	setOverrideProperty(boolean val, String... names)	Set the value for an UnsignedInteger type property
JSProperty<?>	setOverrideProperty(String val, String... names)	Set the value for a string type property
JSProperty<?>	setOverrideProperty(JSUnsignedInteger val, String... names)	Set the value for an UnsignedInteger type property
JSProperty<?>	setOverrideProperty(JSValue val, String... names)	Set the value for a property

Methods inherited from interface org.bedework.jsforj.model.values.JSValue

clear, copy, getBooleanProperty, getBooleanValue, getChanged, getNode, getObjectType, getOverrideGenerated, getOwner, getParentProperty, getProperties, getProperty, getProperty, getPropertyValue, getStringProperty, getStringValue, getType, getUnsignedIntegerProperty, getValue, hasChanges, hasProperty, isString, makeProperty, markOverrideGenerated, newProperty, preWrite, removeProperty, setProperty, setProperty, setProperty, setProperty, setProperty, writeValue, writeValueAsString, writeValueAsStringFormatted

Method Detail

setNull

void setNull(String... name)

Sets the named property to have a value of null. This is only used for patch objects to signify the removal of a property by an override.

Parameters:

name - of properties - generates a path

setOverrideProperty

JSProperty<?> setOverrideProperty(JSValue val,
                                  String... names)

Set the value for a property

Parameters:

val - the property value - non null

names - the property names - non null - forms path

Returns:

the property

setOverrideProperty

JSProperty<?> setOverrideProperty(String val,
                                  String... names)

Set the value for a string type property

Parameters:

val - the property value - non null

names - the property names - non null - forms path

Returns:

the property

setOverrideProperty

JSProperty<?> setOverrideProperty(JSUnsignedInteger val,
                                  String... names)

Set the value for an UnsignedInteger type property

Parameters:

val - the property value - non null

names - the property names - non null - forms path

Returns:

the property

setOverrideProperty

JSProperty<?> setOverrideProperty(boolean val,
                                  String... names)

Set the value for an UnsignedInteger type property

Parameters:

val - the property value - non null

names - the property names - non null - forms path

Returns:

the property

newOverrideProperty

<T extends JSValue> JSProperty<T> newOverrideProperty(com.fasterxml.jackson.core.type.TypeReference<T> typeRef,
                                                      String type,
                                                      String... names)

Create a property of the given type. NOT added or set

Parameters:

typeRef - the property typeref

type - the property type

names - the property names - non null

Returns:

the property