com.izforge.izpack.panels.userinput.field.Choice Maven / Gradle / Ivy
/*
* IzPack - Copyright 2001-2012 Julien Ponge, All Rights Reserved.
*
* http://izpack.org/
* http://izpack.codehaus.org/
*
* Copyright 2012 Tim Anderson
*
* 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 com.izforge.izpack.panels.userinput.field;
/**
* A pair of values. The key identifies the pair, and the value is used for display purposes.
*
* @author Tim Anderson
*/
public class Choice
{
/**
* The key.
*/
private final String key;
/**
* The display value.
*/
private final String value;
/**
* Optional condition, may be null.
*/
private final String conditionId;
/**
* Constructs a {@code Choice}.
*
* @param key the key
* @param value the display value
*/
public Choice(String key, String value, String conditionId)
{
this.key = key;
this.value = value;
this.conditionId = conditionId;
}
public Choice(String key, String value)
{
this(key, value, null);
}
/**
* Returns the key, otherwise known as the true value.
*
* @return the key
*/
public String getKey()
{
return key;
}
/**
* Returns the 'true' value, otherwise known as the key.
*
* @return the 'true' value
*/
public String getTrueValue() { return getKey(); }
/**
* Returns the display value.
*
* @return the display value
*/
public String getValue()
{
return value;
}
/**
* Returns the optional condition ID.
*
* @return the condition ID, might be null
*/
public String getConditionId()
{
return conditionId;
}
/**
* Returns the display value.
*
* @return the display value
*/
public String toString()
{
return value;
}
}