org.springframework.social.google.api.impl

Class PatchBuilder

java.lang.Object

org.springframework.social.google.api.impl.PatchBuilder

public class PatchBuilder
extends java.lang.Object

A builder of a map to be used as the request body of PATCH operations. The following code:

 new PatchBuilder()
        .set("labels.starred", true)
        .set("labels.hidden", false)
        .getMap();
 

returns a Map, which will be serialized to the following JSON:

 {
        "labels": {
                "starred": true,
                "hidden": false
                }
        }
 }
 

Author:

Gabriel Axel

See Also:

AbstractGoogleApiOperations.patch(String, Object, Class)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PATH_DELIMITER

Constructor Summary

Constructors

Constructor and Description
PatchBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
PatchBuilder	delete(java.lang.String path) Defines a property to be deleted by setting its value to null.
java.util.Map<java.lang.String,java.lang.Object>	getMap() Returns the map created so far
PatchBuilder	set(java.lang.String path, java.lang.Enum<?> value) Adds a property and a value to be set in the PATCH request
PatchBuilder	set(java.lang.String path, java.lang.Object value) Adds a property and a value to be set in the PATCH request

Methods inherited from class java.lang.Object

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

Field Detail

PATH_DELIMITER

public static final java.lang.String PATH_DELIMITER

See Also:

Constant Field Values

Constructor Detail

PatchBuilder

public PatchBuilder()

Method Detail

set

public PatchBuilder set(java.lang.String path,
               java.lang.Object value)

Adds a property and a value to be set in the PATCH request

Parameters:

path - the path representing the property, with "." representing nested properties

value - the value to be set for the property

Returns:

the PatchBuilder instance

set

public PatchBuilder set(java.lang.String path,
               java.lang.Enum<?> value)

Adds a property and a value to be set in the PATCH request

Parameters:

path - the path representing the property, with "." representing nested properties

value - the value to be set for the property

Returns:

the PatchBuilder instance

delete

public PatchBuilder delete(java.lang.String path)

Defines a property to be deleted by setting its value to null. Equivalent to invoking set(String, Object) with null value

Parameters:

path - the path representing the property, with "." representing nested properties

Returns:

the PatchBuilder instance

getMap

public java.util.Map<java.lang.String,java.lang.Object> getMap()

Returns the map created so far

Returns:

Map with the set properties