Package de.captaingoldfish.scim.sdk.common.request

Class PatchRequestOperation

java.lang.Object

com.fasterxml.jackson.databind.JsonSerializable.Base

com.fasterxml.jackson.databind.JsonNode

com.fasterxml.jackson.databind.node.BaseJsonNode

com.fasterxml.jackson.databind.node.ContainerNode<com.fasterxml.jackson.databind.node.ObjectNode>

com.fasterxml.jackson.databind.node.ObjectNode

de.captaingoldfish.scim.sdk.common.resources.base.ScimObjectNode

de.captaingoldfish.scim.sdk.common.request.PatchRequestOperation

All Implemented Interfaces:

com.fasterxml.jackson.core.TreeNode, com.fasterxml.jackson.databind.JsonSerializable, com.fasterxml.jackson.databind.node.JsonNodeCreator, ScimNode, Serializable, Iterable<com.fasterxml.jackson.databind.JsonNode>

public class PatchRequestOperation
extends ScimObjectNode

author Pascal Knueppel
created at: 29.10.2019 - 08:32

represents a single operation within a patch request

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PatchRequestOperation.PatchRequestOperationBuilder

Nested classes/interfaces inherited from interface com.fasterxml.jackson.databind.JsonSerializable

com.fasterxml.jackson.databind.JsonSerializable.Base

Field Summary

Fields inherited from class com.fasterxml.jackson.databind.node.ObjectNode

_children

Fields inherited from class com.fasterxml.jackson.databind.node.ContainerNode

_nodeFactory

Constructor Summary

Constructors

Constructor	Description
PatchRequestOperation()
PatchRequestOperation(String path, PatchOp op, List<String> values, com.fasterxml.jackson.databind.JsonNode valueNode)

Method Summary

Modifier and Type	Method	Description
static PatchRequestOperation.PatchRequestOperationBuilder	builder()
PatchOp	getOp()	Each PATCH operation object MUST have exactly one "op" member, whose value indicates the operation to perform and MAY be one of "add", "remove", or "replace" (This will never return null on server side for schema validation is executed before this method is called)
Optional<String>	getPath()	The "path" attribute value is a String containing an attribute path describing the target of the operation.The "path" attribute is OPTIONAL for "add" and "replace" and is REQUIRED for "remove" operations.
Optional<com.fasterxml.jackson.databind.node.ArrayNode>	getValueNode()	reads the value-attribute and if it is not an ArrayNode it will be parsed to a JsonNode that will be embedded within an ArrayNode
List<String>	getValues()	the new value of the targeted attribute (This will never return null on server side for schema validation is executed before this method is called)
void	setOp(PatchOp patchOp)	Each PATCH operation object MUST have exactly one "op" member, whose value indicates the operation to perform and MAY be one of "add", "remove", or "replace"
void	setPath(String path)	The "path" attribute value is a String containing an attribute path describing the target of the operation.The "path" attribute is OPTIONAL for "add" and "replace" and is REQUIRED for "remove" operations.
void	setValueNode(com.fasterxml.jackson.databind.JsonNode value)	the new value of the targeted attribute. in this case the value is represented by the resource itself
void	setValues(List<String> value)	the new value of the targeted attribute

Methods inherited from class de.captaingoldfish.scim.sdk.common.resources.base.ScimObjectNode

addAttribute, getArrayAttribute, getBooleanAttribute, getDateTimeAttribute, getDoubleAttribute, getIntegerAttribute, getLongAttribute, getObjectAttribute, getSchemaAttribute, getSimpleArrayAttribute, getSimpleArrayAttribute, getSimpleArrayAttributeSet, getSimpleArrayAttributeSet, getStringAttribute, getStringAttribute, isEmpty, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeList, setDateTimeAttribute, setDateTimeAttribute, setDateTimeAttribute, setDateTimeAttribute, setStringAttributeList, setStringAttributeList, toPrettyString, toString

Methods inherited from class com.fasterxml.jackson.databind.node.ObjectNode

_at, _childrenEqual, _put, asToken, deepCopy, elements, equals, equals, fieldNames, fields, findParent, findParents, findValue, findValues, findValuesAsText, get, get, getNodeType, hashCode, isEmpty, isObject, path, path, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, putAll, putAll, putArray, putIfAbsent, putNull, putObject, putPOJO, putRawValue, remove, remove, removeAll, replace, required, retain, retain, serialize, serializeWithType, set, setAll, setAll, size, with, withArray, without, without

Methods inherited from class com.fasterxml.jackson.databind.node.ContainerNode

arrayNode, arrayNode, asText, binaryNode, binaryNode, booleanNode, missingNode, nullNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, numberNode, objectNode, pojoNode, rawValueNode, textNode

Methods inherited from class com.fasterxml.jackson.databind.node.BaseJsonNode

findPath, numberType, required, traverse, traverse

Methods inherited from class com.fasterxml.jackson.databind.JsonNode

_reportRequiredViolation, _this, asBoolean, asBoolean, asDouble, asDouble, asInt, asInt, asLong, asLong, asText, at, at, bigIntegerValue, binaryValue, booleanValue, canConvertToExactIntegral, canConvertToInt, canConvertToLong, decimalValue, doubleValue, findParents, findValues, findValuesAsText, floatValue, has, has, hasNonNull, hasNonNull, intValue, isArray, isBigDecimal, isBigInteger, isBinary, isBoolean, isContainerNode, isDouble, isFloat, isFloatingPointNumber, isInt, isIntegralNumber, isLong, isMissingNode, isNull, isNumber, isPojo, isShort, isTextual, isValueNode, iterator, longValue, numberValue, require, requiredAt, requiredAt, requireNonNull, shortValue, textValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface de.captaingoldfish.scim.sdk.common.resources.base.ScimNode

getAttributeDescription, getAttributeName, getCanonicalValues, getMutability, getReferenceTypes, getReturned, getScimNodeName, getUniqueness, getValueType, isCaseExact, isMultiValued, isRequired

Constructor Detail

PatchRequestOperation

public PatchRequestOperation(String path,
                             PatchOp op,
                             List<String> values,
                             com.fasterxml.jackson.databind.JsonNode valueNode)

PatchRequestOperation

public PatchRequestOperation()

Method Detail

getPath

public Optional<String> getPath()

The "path" attribute value is a String containing an attribute path describing the target of the operation.The "path" attribute is OPTIONAL for "add" and "replace" and is REQUIRED for "remove" operations.

setPath

public void setPath(String path)

The "path" attribute value is a String containing an attribute path describing the target of the operation.The "path" attribute is OPTIONAL for "add" and "replace" and is REQUIRED for "remove" operations.

getOp

public PatchOp getOp()

Each PATCH operation object MUST have exactly one "op" member, whose value indicates the operation to perform and MAY be one of "add", "remove", or "replace"
(This will never return null on server side for schema validation is executed before this method is called)

setOp

public void setOp(PatchOp patchOp)

Each PATCH operation object MUST have exactly one "op" member, whose value indicates the operation to perform and MAY be one of "add", "remove", or "replace"

getValues

public List<String> getValues()

the new value of the targeted attribute
(This will never return null on server side for schema validation is executed before this method is called)

setValues

public void setValues(List<String> value)

the new value of the targeted attribute

getValueNode

public Optional<com.fasterxml.jackson.databind.node.ArrayNode> getValueNode()

reads the value-attribute and if it is not an ArrayNode it will be parsed to a JsonNode that will be embedded within an ArrayNode

setValueNode

public void setValueNode(com.fasterxml.jackson.databind.JsonNode value)

the new value of the targeted attribute. in this case the value is represented by the resource itself

builder

public static PatchRequestOperation.PatchRequestOperationBuilder builder()