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

Class HorizontalRule

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A ParagraphElement representing a horizontal line.

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

Method Summary

Modifier and Type	Method and Description
HorizontalRule	clone()
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 HorizontalRule, keyed by suggestion ID.
TextStyle	getTextStyle() The text style of this HorizontalRule.
HorizontalRule	set(String fieldName, Object value)
HorizontalRule	setSuggestedDeletionIds(List<String> suggestedDeletionIds) The suggested deletion IDs.
HorizontalRule	setSuggestedInsertionIds(List<String> suggestedInsertionIds) The suggested insertion IDs.
HorizontalRule	setSuggestedTextStyleChanges(Map<String,SuggestedTextStyle> suggestedTextStyleChanges) The suggested text style changes to this HorizontalRule, keyed by suggestion ID.
HorizontalRule	setTextStyle(TextStyle textStyle) The text style of this HorizontalRule.

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

HorizontalRule

public HorizontalRule()

Method Detail

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 HorizontalRule 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 HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.

Returns:

value or null for none

setSuggestedInsertionIds

public HorizontalRule setSuggestedInsertionIds(List<String> suggestedInsertionIds)

The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is 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 HorizontalRule, keyed by suggestion ID.

Returns:

value or null for none

setSuggestedTextStyleChanges

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

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

Parameters:

suggestedTextStyleChanges - suggestedTextStyleChanges or null for none

getTextStyle

public TextStyle getTextStyle()

The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it.

Returns:

value or null for none

setTextStyle

public HorizontalRule setTextStyle(TextStyle textStyle)

The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it.

Parameters:

textStyle - textStyle or null for none

set

public HorizontalRule set(String fieldName,
                          Object value)

Overrides:

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

clone

public HorizontalRule clone()

Overrides:

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