org.openbp.jaspira.option.LocalizableOptionString Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openbp-cockpit Show documentation

OpenBP Cockpit (graphical process modeler)

The newest version!

/*
 *   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 org.openbp.jaspira.option;

/**
 * A simple wrapper class that holds an arbitrary value and its display text.
 * The display text is returned by the toString method, so it can be used conveniently
 * to display the object.
 *
 * @author Jens Ferchland
 */
public class LocalizableOptionString
{
	/** Display text */
	private String displayText;

	/** Option value */
	private Object value;

	/**
	 * Constructor.
	 *
	 * @param displayText Display text
	 * @param value Option value
	 */
	public LocalizableOptionString(String displayText, Object value)
	{
		this.displayText = displayText;
		this.value = value;
	}

	/**
	 * Returns the display text as string representation of this object.
	 */
	public String toString()
	{
		return displayText;
	}

	/**
	 * Gets the display text.
	 */
	public String getDisplayText()
	{
		return displayText;
	}

	/**
	 * Gets the option value.
	 */
	public Object getValue()
	{
		return value;
	}
}