PatchOp (PayPal Server SDK 1.0.0 API)

java.lang.Object
- java.lang.Enum<PatchOp>
- - com.paypal.sdk.models.PatchOp

All Implemented Interfaces:

Serializable, Comparable<PatchOp>
```
public enum PatchOp
extends Enum<PatchOp>
```
PatchOp to be used.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`_UNKNOWN` Unknown values will be mapped by this enum member
`ADD` Depending on the target location reference, completes one of these functions: The target location is an array index.
`COPY` Copies the value at a specified location to the target location.
`MOVE` Removes the value at a specified location and adds it to the target location.
`REMOVE` Removes the value at the target location.
`REPLACE` Replaces the value at the target location with a new value.
`TEST` Tests that a value at the target location is equal to a specified value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PatchOp`	`constructFromString(String toConvert)` Returns the enum member associated with the given string value.
`static PatchOp`	`fromString(String toConvert)` Returns the enum member associated with the given string value.
`String`	`toString()` Get string representation of this enum.
`static List<String>`	`toValue(List<PatchOp> toConvert)` Convert list of PatchOp values to list of string values.
`String`	`value()` Returns the string value associated with the enum member.
`static PatchOp`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static PatchOp[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ADD
```
public static final PatchOp 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. For more information, see 4.1. add.
  - REMOVE
```
public static final PatchOp REMOVE
```
    Removes the value at the target location. For the operation to succeed, the target location must exist. For more information, see 4.2. remove.
  - REPLACE
```
public static final PatchOp 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. For more information, see 4.3. replace.
  - MOVE
```
public static final PatchOp 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. For more information, see 4.4. move.
  - COPY
```
public static final PatchOp 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. For more information, see 4.5. copy.
  - TEST
```
public static final PatchOp 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: Type Considered equal if both values 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. For more information, see 4.6. test.
  - _UNKNOWN
```
public static final PatchOp _UNKNOWN
```
    Unknown values will be mapped by this enum member
- Method Detail
  - values
```
public static PatchOp[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (PatchOp c : PatchOp.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PatchOp valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - constructFromString
```
public static PatchOp constructFromString(String toConvert)
                                   throws IOException
```
    Returns the enum member associated with the given string value.
    
    Parameters:
    
    toConvert - String value to get enum member.
    
    Returns:
    
    The enum member against the given string value.
    
    Throws:
    
    IOException - when provided value is not mapped to any enum member.
  - fromString
```
public static PatchOp fromString(String toConvert)
```
    Returns the enum member associated with the given string value.
    
    Parameters:
    
    toConvert - String value to get enum member.
    
    Returns:
    
    The enum member against the given string value.
  - value
```
public String value()
```
    Returns the string value associated with the enum member.
    
    Returns:
    
    The string value against enum member.
  - toString
```
public String toString()
```
    Get string representation of this enum.
    
    Overrides:
    
    toString in class Enum<PatchOp>
  - toValue
```
public static List<String> toValue(List<PatchOp> toConvert)
```
    Convert list of PatchOp values to list of string values.
    
    Parameters:
    
    toConvert - The list of PatchOp values to convert.
    
    Returns:
    
    List of representative string values.

Enum PatchOp

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ADD

REMOVE

REPLACE

MOVE

COPY

TEST

_UNKNOWN

Method Detail

values

valueOf

constructFromString

fromString

value

toString

toValue