com.google.api.services.docs.v1.model

Class Location

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.docs.v1.model.Location

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Location
extends com.google.api.client.json.GenericJson

A particular location in the document.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Docs API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Location()

Method Summary

Modifier and Type	Method and Description
Location	clone()
Integer	getIndex() The zero-based index, in UTF-16 code units.
String	getSegmentId() The ID of the header, footer or footnote the location is in.
String	getTabId() The tab that the location is in.
Location	set(String fieldName, Object value)
Location	setIndex(Integer index) The zero-based index, in UTF-16 code units.
Location	setSegmentId(String segmentId) The ID of the header, footer or footnote the location is in.
Location	setTabId(String tabId) The tab that the location is in.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Location

public Location()

Method Detail

getIndex

public Integer getIndex()

The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id.

Returns:

value or null for none

setIndex

public Location setIndex(Integer index)

The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id.

Parameters:

index - index or null for none

getSegmentId

public String getSegmentId()

The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body.

Returns:

value or null for none

setSegmentId

public Location setSegmentId(String segmentId)

The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body.

Parameters:

segmentId - segmentId or null for none

getTabId

public String getTabId()

The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.

Returns:

value or null for none

setTabId

public Location setTabId(String tabId)

The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.

Parameters:

tabId - tabId or null for none

set

public Location set(String fieldName,
                    Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Location clone()

Overrides:

clone in class com.google.api.client.json.GenericJson