File: CandlestickData.java

package info (click to toggle)
google-api-services-sheets-java 1.32.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 2,008 kB
  • sloc: java: 12,826; xml: 161; makefile: 2
file content (156 lines) | stat: -rw-r--r-- 5,520 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
/*
 * 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/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.sheets.v4.model;

/**
 * The Candlestick chart data, each containing the low, open, close, and high values for a series.
 *
 * <p> 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 Sheets API. For a detailed explanation see:
 * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
 * </p>
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class CandlestickData extends com.google.api.client.json.GenericJson {

  /**
   * The range data (vertical axis) for the close/final value for each candle. This is the top of
   * the candle body. If greater than the open value the candle will be filled. Otherwise the candle
   * will be hollow.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private CandlestickSeries closeSeries;

  /**
   * The range data (vertical axis) for the high/maximum value for each candle. This is the top of
   * the candle's center line.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private CandlestickSeries highSeries;

  /**
   * The range data (vertical axis) for the low/minimum value for each candle. This is the bottom of
   * the candle's center line.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private CandlestickSeries lowSeries;

  /**
   * The range data (vertical axis) for the open/initial value for each candle. This is the bottom
   * of the candle body. If less than the close value the candle will be filled. Otherwise the
   * candle will be hollow.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private CandlestickSeries openSeries;

  /**
   * The range data (vertical axis) for the close/final value for each candle. This is the top of
   * the candle body. If greater than the open value the candle will be filled. Otherwise the candle
   * will be hollow.
   * @return value or {@code null} for none
   */
  public CandlestickSeries getCloseSeries() {
    return closeSeries;
  }

  /**
   * The range data (vertical axis) for the close/final value for each candle. This is the top of
   * the candle body. If greater than the open value the candle will be filled. Otherwise the candle
   * will be hollow.
   * @param closeSeries closeSeries or {@code null} for none
   */
  public CandlestickData setCloseSeries(CandlestickSeries closeSeries) {
    this.closeSeries = closeSeries;
    return this;
  }

  /**
   * The range data (vertical axis) for the high/maximum value for each candle. This is the top of
   * the candle's center line.
   * @return value or {@code null} for none
   */
  public CandlestickSeries getHighSeries() {
    return highSeries;
  }

  /**
   * The range data (vertical axis) for the high/maximum value for each candle. This is the top of
   * the candle's center line.
   * @param highSeries highSeries or {@code null} for none
   */
  public CandlestickData setHighSeries(CandlestickSeries highSeries) {
    this.highSeries = highSeries;
    return this;
  }

  /**
   * The range data (vertical axis) for the low/minimum value for each candle. This is the bottom of
   * the candle's center line.
   * @return value or {@code null} for none
   */
  public CandlestickSeries getLowSeries() {
    return lowSeries;
  }

  /**
   * The range data (vertical axis) for the low/minimum value for each candle. This is the bottom of
   * the candle's center line.
   * @param lowSeries lowSeries or {@code null} for none
   */
  public CandlestickData setLowSeries(CandlestickSeries lowSeries) {
    this.lowSeries = lowSeries;
    return this;
  }

  /**
   * The range data (vertical axis) for the open/initial value for each candle. This is the bottom
   * of the candle body. If less than the close value the candle will be filled. Otherwise the
   * candle will be hollow.
   * @return value or {@code null} for none
   */
  public CandlestickSeries getOpenSeries() {
    return openSeries;
  }

  /**
   * The range data (vertical axis) for the open/initial value for each candle. This is the bottom
   * of the candle body. If less than the close value the candle will be filled. Otherwise the
   * candle will be hollow.
   * @param openSeries openSeries or {@code null} for none
   */
  public CandlestickData setOpenSeries(CandlestickSeries openSeries) {
    this.openSeries = openSeries;
    return this;
  }

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

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

}