jfxtras.icalendarfx.parameters.VParameter Maven / Gradle / Ivy

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

Miscellaneous components for JavaFX

The newest version!

package jfxtras.icalendarfx.parameters;

import jfxtras.icalendarfx.VChild;

/**
 * Every parameter requires the following methods:
 * toContentLine - make iCalendar string
 * getValue - return parameters value
 * isEqualsTo - checks equality between two parameters
 * parse - convert string into parameter - this method is in ParameterEnum
 * 
 * @author David Bal
 * @param  - parameter value type
 *
 */
public interface VParameter extends VChild
{    
    /**
     * The value of the parameter.
     * 
     * For example, in the below parameter:
     * CN=John Doe
     * The value is the String "John Doe"
     * 
     * Note: the value's object must have an overridden toString method that complies
     * with iCalendar content line output.
     */
    T getValue();
    
    /** Set the value of this parameter */  
    void setValue(T value);
}