com.github.fge.uritemplate.vars.values.VariableValue Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2013, Francis Galiegue 
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Lesser GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * 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
 * Lesser 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.fge.uritemplate.vars.values;

import com.github.fge.msgsimple.bundle.MessageBundle;
import com.github.fge.msgsimple.load.MessageBundles;
import com.github.fge.uritemplate.URITemplateMessageBundle;

import java.util.List;
import java.util.Map;

/**
 * Abstract class for one variable value
 */
public abstract class VariableValue
{
    protected static final MessageBundle BUNDLE
        = MessageBundles.getBundle(URITemplateMessageBundle.class);

    private final ValueType type;

    protected VariableValue(final ValueType type)
    {
        this.type = type;
    }

    /**
     * Get the type for this value
     *
     * @return the value type
     */
    public final ValueType getType()
    {
        return type;
    }

    /**
     * Get a simple string for this value
     *
     * Only valid for string values
     *
     * @return the string
     * @throws IllegalArgumentException value is not a string value
     */
    public String getScalarValue()
    {
        throw new IllegalArgumentException(BUNDLE.printf("value.notScalar",
            type));
    }

    /**
     * Get a list for this value
     *
     * Only valid for list values
     *
     * @return the list
     * @throws IllegalArgumentException value is not a list value
     */
    public List getListValue()
    {
        throw new IllegalArgumentException(BUNDLE.printf("value.notList",
            type));
    }

    /**
     * Get a map for this value
     *
     * Only valid for map values
     *
     * @return the map
     * @throws IllegalArgumentException value is not a map value
     */
    public Map getMapValue()
    {
        throw new IllegalArgumentException(BUNDLE.printf("value.notMap",
            type));
    }

    /**
     * Tell whether this value is empty
     *
     * For strings, this tells whether the string itself is empty. For lists
     * and maps, this tells whether the list or map have no elements/entries.
     * 
     *
     * @return true if the value is empty
     */
    public abstract boolean isEmpty();
}