Package com.broadleafcommerce.paypal.micro.gateway.domain.orders

Class Patch

java.lang.Object

com.broadleafcommerce.paypal.micro.gateway.domain.orders.Patch

All Implemented Interfaces:

Serializable

public class Patch
extends Object
implements Serializable

The JSON patch object to apply partial updates to resources.

Author:

Dima Myroniuk (dmyroniuk)

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Patch.Operation

Constructor Summary

Constructors

Constructor	Description
Patch()

Method Summary

Modifier and Type	Method	Description
String	getFrom()	The JSON Pointer to the target document location from which to move the value.
String	getOp()	The operation.
String	getPath()	The JSON Pointer to the target document location at which to complete the operation.
Object	getValue()	The value to apply.
void	setFrom(String from)	The JSON Pointer to the target document location from which to move the value.
void	setOp(String op)	The operation.
void	setPath(String path)	The JSON Pointer to the target document location at which to complete the operation.
void	setValue(Object value)	The value to apply.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Patch

public Patch()

Method Details

setOp

public void setOp(String op)

The operation. The possible values are:

• add. Depending on the target location reference, completes one of these functions:
  • The target location is an array index. Inserts a new value into the array at the specified index.
  • The target location is an object parameter that does not already exist. Adds a new parameter to the object.
  • The target location is an object parameter that does exist. Replaces that parameter's value.
  The value parameter defines the value to add
• remove. Removes the value at the target location. For the operation to succeed, the target location must exist.
• replace. Replaces the value at the target location with a new value. The operation object must contain a value parameter that defines the replacement value. For the operation to succeed, the target location must exist.
• move. Removes the value at a specified location and adds it to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to move the value. For the operation to succeed, the from location must exist.
• copy. Copies the value at a specified location to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to copy the value. For the operation to succeed, the from location must exist.
• test. Tests that a value at the target location is equal to a specified value. The operation object must contain a value parameter that defines the value to compare to the target location's value. For the operation to succeed, the target location must be equal to the value value. For test, equal indicates that the value at the target location and the value that value defines are of the same JSON type. The data type of the value determines how equality is defined:
  • strings - contain the same number of Unicode characters and their code points are byte-by-byte equal.
  • numbers - Are numerically equal.
  • arrays - Contain the same number of values, and each value is equal to the value at the corresponding position in the other array, by using these type-specific rules.
  • objects - Contain the same number of parameters, and each parameter is equal to a parameter in the other object, by comparing their keys (as strings) and their values (by using these type-specific rules).
  • literals (false, true, and null) - Are the same. The comparison is a logical comparison. For example, whitespace between the parameter values of an array is not significant. Also, ordering of the serialization of object parameters is not significant.

setFrom

public void setFrom(String from)

The JSON Pointer to the target document location from which to move the value. Required for the "move" operation.

setPath

public void setPath(String path)

The JSON Pointer to the target document location at which to complete the operation.

setValue

public void setValue(Object value)

The value to apply. The "remove" operation does not require a value.

getOp

public String getOp()

The operation. The possible values are:

• add. Depending on the target location reference, completes one of these functions:
  • The target location is an array index. Inserts a new value into the array at the specified index.
  • The target location is an object parameter that does not already exist. Adds a new parameter to the object.
  • The target location is an object parameter that does exist. Replaces that parameter's value.
  The value parameter defines the value to add
• remove. Removes the value at the target location. For the operation to succeed, the target location must exist.
• replace. Replaces the value at the target location with a new value. The operation object must contain a value parameter that defines the replacement value. For the operation to succeed, the target location must exist.
• move. Removes the value at a specified location and adds it to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to move the value. For the operation to succeed, the from location must exist.
• copy. Copies the value at a specified location to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to copy the value. For the operation to succeed, the from location must exist.
• test. Tests that a value at the target location is equal to a specified value. The operation object must contain a value parameter that defines the value to compare to the target location's value. For the operation to succeed, the target location must be equal to the value value. For test, equal indicates that the value at the target location and the value that value defines are of the same JSON type. The data type of the value determines how equality is defined:
  • strings - contain the same number of Unicode characters and their code points are byte-by-byte equal.
  • numbers - Are numerically equal.
  • arrays - Contain the same number of values, and each value is equal to the value at the corresponding position in the other array, by using these type-specific rules.
  • objects - Contain the same number of parameters, and each parameter is equal to a parameter in the other object, by comparing their keys (as strings) and their values (by using these type-specific rules).
  • literals (false, true, and null) - Are the same. The comparison is a logical comparison. For example, whitespace between the parameter values of an array is not significant. Also, ordering of the serialization of object parameters is not significant.

getFrom

public String getFrom()

The JSON Pointer to the target document location from which to move the value. Required for the "move" operation.

getPath

public String getPath()

The JSON Pointer to the target document location at which to complete the operation.

getValue

public Object getValue()

The value to apply. The "remove" operation does not require a value.