biweekly.property.Color Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of biweekly Show documentation
An iCalendar parser/writer library written in Java.
There is a newer version: 0.6.8
package biweekly.property;

/*
 Copyright (c) 2013-2021, Michael Angstadt
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met: 

 1. Redistributions of source code must retain the above copyright notice, this
 list of conditions and the following disclaimer. 
 2. Redistributions in binary form must reproduce the above copyright notice,
 this list of conditions and the following disclaimer in the documentation
 and/or other materials provided with the distribution. 

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * 
 * Defines a color that clients may use when displaying the component data.
 * Clients may use this color in any way they wish. For example, they can use it
 * as a background color.
 * 
 * 
 * Acceptable values are defined in Section
 * 4.3 of the CSS Color Module Level 3 Recommendation. For example,
 * "aliceblue", "green", "navy".
 * 
 * 
 * Code sample:
 * 
 * 
 *  * VEvent event = new VEvent();
 * 
 * Color color = new Color("mistyrose");
 * event.setColor(color);
 * 
 * @author Michael Angstadt
 * @see draft-ietf-calext-extensions-01
 * p.9
 */
public class Color extends TextProperty {
	/**
	 * Creates a color property.
	 * @param color the color name (case insensitive). Acceptable values are
	 * defined in Section 4.3 of the CSS Color Module Level 3 Recommendation. For
	 * example, "aliceblue", "green", "navy".
	 */
	public Color(String color) {
		super(color);
	}

	/**
	 * Copy constructor.
	 * @param original the property to make a copy of
	 */
	public Color(Color original) {
		super(original);
	}

	/**
	 * Gets the value of this property.
	 * @return the value (case insensitive). Acceptable values are defined in Section 4.3 of the CSS Color Module Level 3 Recommendation. For
	 * example, "aliceblue", "green", "navy".
	 */
	@Override
	public String getValue() {
		return super.getValue();
	}

	/**
	 * Sets the value of this property.
	 * @param value the value (case insensitive). Acceptable values are defined
	 * in Section 4.3 of the CSS Color Module Level 3 Recommendation. For
	 * example, "aliceblue", "green", "navy".
	 */
	@Override
	public void setValue(String value) {
		super.setValue(value);
	}

	@Override
	public Color copy() {
		return new Color(this);
	}

	@Override
	protected int valueHashCode() {
		return value.toLowerCase().hashCode();
	}

	@Override
	protected boolean valueEquals(String otherValue) {
		return value.equalsIgnoreCase(otherValue);
	}
}