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

Class Range

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.Range

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Specifies a contiguous range of text.

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
Range()

Method Summary

Modifier and Type	Method and Description
Range	clone()
Integer	getEndIndex() The zero-based end index of this range, exclusive, in UTF-16 code units.
String	getSegmentId() The ID of the header, footer, or footnote that this range is contained in.
Integer	getStartIndex() The zero-based start index of this range, in UTF-16 code units.
String	getTabId() The tab that contains this range.
Range	set(String fieldName, Object value)
Range	setEndIndex(Integer endIndex) The zero-based end index of this range, exclusive, in UTF-16 code units.
Range	setSegmentId(String segmentId) The ID of the header, footer, or footnote that this range is contained in.
Range	setStartIndex(Integer startIndex) The zero-based start index of this range, in UTF-16 code units.
Range	setTabId(String tabId) The tab that contains this range.

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

Range

public Range()

Method Detail

getEndIndex

public Integer getEndIndex()

The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.

Returns:

value or null for none

setEndIndex

public Range setEndIndex(Integer endIndex)

The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.

Parameters:

endIndex - endIndex or null for none

getSegmentId

public String getSegmentId()

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

Returns:

value or null for none

setSegmentId

public Range setSegmentId(String segmentId)

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

Parameters:

segmentId - segmentId or null for none

getStartIndex

public Integer getStartIndex()

The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.

Returns:

value or null for none

setStartIndex

public Range setStartIndex(Integer startIndex)

The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.

Parameters:

startIndex - startIndex or null for none

getTabId

public String getTabId()

The tab that contains this range. When omitted, the request applies 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 Range setTabId(String tabId)

The tab that contains this range. When omitted, the request applies 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 Range set(String fieldName,
                 Object value)

Overrides:

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

clone

public Range clone()

Overrides:

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