co.cask.wrangler.api.parser.Bool Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wrangler-api Show documentation
Wrangler API Libaray.
There is a newer version: 3.2.2
/*
 * Copyright © 2017 Cask Data, 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.
 */

package co.cask.wrangler.api.parser;

import co.cask.wrangler.api.annotations.PublicEvolving;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;

/**
 * The Bool class wraps the primitive type {@code Boolean} in a object.
 * An object of type {@code Bool} contains the value in primitive type
 * as well as the type of the token this class represents.
 *
 * In addition, this class provides two methods one to extract the
 * value held by this wrapper object, and the second for extracting the
 * type of the token.
 *
 * @see BoolList
 * @see ColumnName
 * @see ColumnNameList
 * @see DirectiveName
 * @see Numeric
 * @see NumericList
 * @see Properties
 * @see Ranges
 * @see Expression
 * @see Text
 * @see TextList
 * @see Identifier
 */
@PublicEvolving
public class Bool implements Token {
  /**
   * The {@code Boolean} object that represents the value held by the token.
   */
  private Boolean value;

  /**
   * Allocates a {@code Boolean} object representing the
   * {@code value} argument.
   *
   * @param value the value of the {@code Boolean}.
   */
  public Bool(Boolean value) {
    this.value = value;
  }

  /**
   * Returns the value of this {@code Boolean} object as a boolean
   * primitive.
   *
   * @return  the primitive {@code boolean} value of this object.
   */
  @Override
  public Boolean value() {
    return value;
  }

  /**
   * Returns the type of this {@code Bool} object as a {@code TokenType}
   * enum.
   *
   * @return the enumerated {@code TokenType} of this object.
   */
  @Override
  public TokenType type() {
    return TokenType.BOOLEAN;
  }

  /**
   * Returns the members of this {@code Bool} object as a {@code JsonElement}.
   *
   * @return Json representation of this {@code Bool} object as {@code JsonElement}
   */
  @Override
  public JsonElement toJson() {
    JsonObject object = new JsonObject();
    object.addProperty("type", TokenType.BOOLEAN.name());
    object.addProperty("value", value);
    return object;
  }
}