biweekly.property

Class ValuedProperty<T>

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.ValuedProperty<T>

Type Parameters:

T - the value class (e.g. String)

Direct Known Subclasses:

DateOrDateTimeProperty, DateTimeProperty, DurationProperty, IntegerProperty, RecurrenceProperty, RefreshInterval, TextProperty, UtcOffsetProperty, Xml

public class ValuedProperty<T>
extends ICalProperty

Represents a property whose data model consists of a single Java object (such as a String).

Author:

Michael Angstadt

Field Summary

Fields

Modifier and Type	Field and Description
protected T	value

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
ValuedProperty(T value) Creates a new valued property.
ValuedProperty(ValuedProperty<T> original) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
T	getValue() Gets the value of this property.
static <T> T	getValue(ValuedProperty<T> property) Utility method that gets the value of a ValuedProperty object.
int	hashCode()
void	setValue(T value) Sets the value of this property.
protected Map<String,Object>	toStringValues() Gets string representations of the class's fields for the ICalProperty.toString() method.
protected void	validate(List<ICalComponent> components, ICalVersion version, List<Warning> warnings) Checks the property for data consistency problems or deviations from the specifications.
protected boolean	valueEquals(T otherValue) Compares this property's value with another property's value for equality.
protected int	valueHashCode() Calculates the hash code of this property's value.

Methods inherited from class biweekly.property.ICalProperty

addParameter, copy, getParameter, getParameters, getParameters, removeParameter, setParameter, setParameter, setParameters, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

value

protected T value

Constructor Detail

ValuedProperty

public ValuedProperty(T value)

Creates a new valued property.

Parameters:

value - the property's value

ValuedProperty

public ValuedProperty(ValuedProperty<T> original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

getValue

public T getValue()

Gets the value of this property.

Returns:

the value

setValue

public void setValue(T value)

Sets the value of this property.

Parameters:

value - the value

validate

protected void validate(List<ICalComponent> components,
            ICalVersion version,
            List<Warning> warnings)

Description copied from class: ICalProperty

Checks the property for data consistency problems or deviations from the specifications.

This method should be overridden by child classes that wish to provide validation logic. The default implementation of this method does nothing.

Overrides:

validate in class ICalProperty

Parameters:

components - the hierarchy of components that the property belongs to

version - the version to validate against

warnings - the list to add the warnings to

getValue

public static <T> T getValue(ValuedProperty<T> property)

Utility method that gets the value of a ValuedProperty object.

Type Parameters:

T - the value class

Parameters:

property - the property object (may be null)

Returns:

the property value (may be null), or null if the property object itself is null

toStringValues

protected Map<String,Object> toStringValues()

Description copied from class: ICalProperty

Gets string representations of the class's fields for the ICalProperty.toString() method.

Meant to be overridden by child classes. The default implementation returns an empty map.

Overrides:

toStringValues in class ICalProperty

Returns:

the values of the class's fields (key = field name, value = field value)

hashCode

public int hashCode()

Overrides:

hashCode in class ICalProperty

equals

public boolean equals(Object obj)

Overrides:

equals in class ICalProperty

valueHashCode

protected int valueHashCode()

Calculates the hash code of this property's value.

This method is meant by to overridden by child classes whose value's hash code cannot be calculated by just invoking hashCode(). For example, a property whose value is case insensitive. The default implementation of this method calls value.hashCode().

This method is only invoked when this property's value is not null.

Returns:

the value's hash code

valueEquals

protected boolean valueEquals(T otherValue)

Compares this property's value with another property's value for equality.

This method is meant by to overridden by child classes when their value's equality cannot be calculated by just invoking equals(). For example, a property whose value is case insensitive. The default implementation of this method calls value.equals(otherValue).

This method is only invoked when this property's value is not null.

Parameters:

otherValue - the other property's value

Returns:

true if this property's value is equal to the other property's value, false if not