com.google.api.services.docs.v1.model.FootnoteReference Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-docs Show documentation
There is a newer version: v1-rev20240730-2.0.0
Show newest version
/*
 * Copyright 2010 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
/*
 * This code was generated by https://github.com/google/apis-client-generator/
 * (build: 2018-10-08 17:45:39 UTC)
 * on 2019-02-11 at 20:39:12 UTC 
 * Modify at your own risk.
 */

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

/**
 * 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.
 */
@SuppressWarnings("javadoc")
public final class FootnoteReference extends com.google.api.client.json.GenericJson {

  /**
   * The ID of the footnote that contains the content of this footnote reference.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String footnoteId;

  /**
   * The rendered number of this footnote.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String footnoteNumber;

  /**
   * The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List suggestedDeletionIds;

  /**
   * The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it is a
   * nested suggested change. If empty, then this is not a suggested insertion.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List suggestedInsertionIds;

  /**
   * The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map suggestedTextStyleChanges;

  /**
   * The text style of this FootnoteReference.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private TextStyle textStyle;

  /**
   * The ID of the footnote that contains the content of this footnote reference.
   * @return value or {@code null} for none
   */
  public java.lang.String getFootnoteId() {
    return footnoteId;
  }

  /**
   * The ID of the footnote that contains the content of this footnote reference.
   * @param footnoteId footnoteId or {@code null} for none
   */
  public FootnoteReference setFootnoteId(java.lang.String footnoteId) {
    this.footnoteId = footnoteId;
    return this;
  }

  /**
   * The rendered number of this footnote.
   * @return value or {@code null} for none
   */
  public java.lang.String getFootnoteNumber() {
    return footnoteNumber;
  }

  /**
   * The rendered number of this footnote.
   * @param footnoteNumber footnoteNumber or {@code null} for none
   */
  public FootnoteReference setFootnoteNumber(java.lang.String footnoteNumber) {
    this.footnoteNumber = footnoteNumber;
    return this;
  }

  /**
   * The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
   * @return value or {@code null} for none
   */
  public java.util.List getSuggestedDeletionIds() {
    return suggestedDeletionIds;
  }

  /**
   * The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
   * @param suggestedDeletionIds suggestedDeletionIds or {@code null} for none
   */
  public FootnoteReference setSuggestedDeletionIds(java.util.List suggestedDeletionIds) {
    this.suggestedDeletionIds = suggestedDeletionIds;
    return this;
  }

  /**
   * The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it is a
   * nested suggested change. If empty, then this is not a suggested insertion.
   * @return value or {@code null} for none
   */
  public java.util.List getSuggestedInsertionIds() {
    return suggestedInsertionIds;
  }

  /**
   * The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it is a
   * nested suggested change. If empty, then this is not a suggested insertion.
   * @param suggestedInsertionIds suggestedInsertionIds or {@code null} for none
   */
  public FootnoteReference setSuggestedInsertionIds(java.util.List suggestedInsertionIds) {
    this.suggestedInsertionIds = suggestedInsertionIds;
    return this;
  }

  /**
   * The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
   * @return value or {@code null} for none
   */
  public java.util.Map getSuggestedTextStyleChanges() {
    return suggestedTextStyleChanges;
  }

  /**
   * The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
   * @param suggestedTextStyleChanges suggestedTextStyleChanges or {@code null} for none
   */
  public FootnoteReference setSuggestedTextStyleChanges(java.util.Map suggestedTextStyleChanges) {
    this.suggestedTextStyleChanges = suggestedTextStyleChanges;
    return this;
  }

  /**
   * The text style of this FootnoteReference.
   * @return value or {@code null} for none
   */
  public TextStyle getTextStyle() {
    return textStyle;
  }

  /**
   * The text style of this FootnoteReference.
   * @param textStyle textStyle or {@code null} for none
   */
  public FootnoteReference setTextStyle(TextStyle textStyle) {
    this.textStyle = textStyle;
    return this;
  }

  @Override
  public FootnoteReference set(String fieldName, Object value) {
    return (FootnoteReference) super.set(fieldName, value);
  }

  @Override
  public FootnoteReference clone() {
    return (FootnoteReference) super.clone();
  }

}