com.github.tnakamot.jscdg.json.token.JSONTokenBoolean Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of json-parser Show documentation

An implementation of Java JSON Parser

There is a newer version: 0.2.1

/*
 *  Copyright (C) 2020 Takashi Nakamoto .
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 3 as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see .
 */

package com.github.tnakamot.jscdg.json.token;

import com.github.tnakamot.jscdg.json.JSONText;

/**
 * Represents one "boolean" type token in JSON text.
 *
 * 
 * Based on RFC 8259, the token text returned
 * by {@link #text()} is either "true" or "false". The representation in Java as a boolean primitive
 * can be obtained by {@link #value()}.
 *
 * 

 * Instances of this class are immutable.
 */
public class JSONTokenBoolean extends JSONToken {
    public static final String JSON_TRUE  = "true";
    public static final String JSON_FALSE = "false";

    private final boolean value;

    /**
     * Creates one "boolean" type token of a JSON text.
     *
     * 
     * It is the caller's responsibility to validate the token text as boolean
     * before creating this instance.
     *
     * @param text   text of this token
     * @param begin  beginning location of this token within the source JSON text
     * @param end    end location of this token within the source JSON text
     * @param source source JSON text where this token was extracted from
     */
    public JSONTokenBoolean(String text, StringLocation begin, StringLocation end, JSONText source) {
        super(JSONTokenType.BOOLEAN, text, begin, end, source);
        if (JSON_TRUE.equals(text)) {
            this.value = true;
        } else if (JSON_FALSE.equals(text)) {
            this.value = false;
        } else {
            throw new IllegalArgumentException(
                    "text of boolean token must be either " + JSON_TRUE + " or " + JSON_FALSE);
        }
    }

    /**
     * @return The boolean value of this token represents.
     */
    public boolean value() {
        return value;
    }
}