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

Class FootnoteReference

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote.

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

Method Summary

Modifier and Type	Method and Description
FootnoteReference	clone()
String	getFootnoteId() The ID of the footnote that contains the content of this footnote reference.
String	getFootnoteNumber() The rendered number of this footnote.
List<String>	getSuggestedDeletionIds() The suggested deletion IDs.
List<String>	getSuggestedInsertionIds() The suggested insertion IDs.
Map<String,SuggestedTextStyle>	getSuggestedTextStyleChanges() The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
TextStyle	getTextStyle() The text style of this FootnoteReference.
FootnoteReference	set(String fieldName, Object value)
FootnoteReference	setFootnoteId(String footnoteId) The ID of the footnote that contains the content of this footnote reference.
FootnoteReference	setFootnoteNumber(String footnoteNumber) The rendered number of this footnote.
FootnoteReference	setSuggestedDeletionIds(List<String> suggestedDeletionIds) The suggested deletion IDs.
FootnoteReference	setSuggestedInsertionIds(List<String> suggestedInsertionIds) The suggested insertion IDs.
FootnoteReference	setSuggestedTextStyleChanges(Map<String,SuggestedTextStyle> suggestedTextStyleChanges) The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
FootnoteReference	setTextStyle(TextStyle textStyle) The text style of this FootnoteReference.

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

FootnoteReference

public FootnoteReference()

Method Detail

getFootnoteId

public String getFootnoteId()

The ID of the footnote that contains the content of this footnote reference.

Returns:

value or null for none

setFootnoteId

public FootnoteReference setFootnoteId(String footnoteId)

The ID of the footnote that contains the content of this footnote reference.

Parameters:

footnoteId - footnoteId or null for none

getFootnoteNumber

public String getFootnoteNumber()

The rendered number of this footnote.

Returns:

value or null for none

setFootnoteNumber

public FootnoteReference setFootnoteNumber(String footnoteNumber)

The rendered number of this footnote.

Parameters:

footnoteNumber - footnoteNumber or null for none

getSuggestedDeletionIds

public List<String> getSuggestedDeletionIds()

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

Returns:

value or null for none

setSuggestedDeletionIds

public FootnoteReference setSuggestedDeletionIds(List<String> suggestedDeletionIds)

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

Parameters:

suggestedDeletionIds - suggestedDeletionIds or null for none

getSuggestedInsertionIds

public List<String> getSuggestedInsertionIds()

The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.

Returns:

value or null for none

setSuggestedInsertionIds

public FootnoteReference setSuggestedInsertionIds(List<String> suggestedInsertionIds)

The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.

Parameters:

suggestedInsertionIds - suggestedInsertionIds or null for none

getSuggestedTextStyleChanges

public Map<String,SuggestedTextStyle> getSuggestedTextStyleChanges()

The suggested text style changes to this FootnoteReference, keyed by suggestion ID.

Returns:

value or null for none

setSuggestedTextStyleChanges

public FootnoteReference setSuggestedTextStyleChanges(Map<String,SuggestedTextStyle> suggestedTextStyleChanges)

The suggested text style changes to this FootnoteReference, keyed by suggestion ID.

Parameters:

suggestedTextStyleChanges - suggestedTextStyleChanges or null for none

getTextStyle

public TextStyle getTextStyle()

The text style of this FootnoteReference.

Returns:

value or null for none

setTextStyle

public FootnoteReference setTextStyle(TextStyle textStyle)

The text style of this FootnoteReference.

Parameters:

textStyle - textStyle or null for none

set

public FootnoteReference set(String fieldName,
                             Object value)

Overrides:

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

clone

public FootnoteReference clone()

Overrides:

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