jfxtras.icalendarfx.parameters.VParameterBase 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 java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import jfxtras.icalendarfx.VElementBase;
import jfxtras.icalendarfx.VParent;
import jfxtras.icalendarfx.parameters.VParameter;
import jfxtras.icalendarfx.parameters.VParameterBase;
import jfxtras.icalendarfx.parameters.VParameterElement;
import jfxtras.icalendarfx.utilities.StringConverter;

/**
 * Base class of all iCalendar Parameters.  Parameters can't have children.
 * Example VALUE=DATE
 * 
 * @author David Bal
 *
 * @param  - type of value stored in the Parameter, such as String for text-based, or the enumerated type of the classes based on an enum
 * @param  - implemented subclass
 */
abstract public class VParameterBase extends VElementBase implements VParameter
{
    private VParent myParent;
    @Override
    public void setParent(VParent parent) { myParent = parent; }
    @Override
    public VParent getParent() { return myParent; }
    
    /*
     * PARAMETER VALUE
     */
    @Override
    public T getValue()
    {
        return value;
    }
    private T value;
    @Override
    public void setValue(T value)
    {
        this.value = value;
    }
    public void setValue(CharSequence value)
    {
    	parseContent(value.toString());
    }
    public U withValue(T value)
    {
        setValue(value);
        return (U) this;
    }
    public U withValue(CharSequence value)
    {
        setValue(value);
        return (U) this;
    }
    
    // convert value to string, is overridden for enum-based parameters to handle UNKNOWN value
    String valueAsString()
    {
    	if (getValue() == null) return "";
        return getConverter().toString(getValue());
    }
    
    @Override
    protected List parseContent(String content)
    {
        String valueString = extractValue(content);
        T value = getConverter().fromString(valueString);
        setValue(value);
        return Collections.EMPTY_LIST;
    }
    
    /**
     * STRING CONVERTER
     * 
     * Get the parameter value string converter.
     */ 
    protected final StringConverter converter;
    private StringConverter getConverter()
    {
        return converter;
    }
    
    /**
     * PARAMETER TYPE
     * 
     *  The enumerated type of the parameter.
     */
    final protected VParameterElement elementType;
    @Override
    public String name()
    {
    	return elementType.toString();
  	}
	
    @Override
    public String toString()
    {
        return name() + "=" + valueAsString();
    }

    @Override // Note: can't check equality of parents - causes stack overflow
    public boolean equals(Object obj)
    {
        if (obj == this) return true;
        if((obj == null) || (obj.getClass() != getClass())) {
            return false;
        }
        VParameterBase testObj = (VParameterBase) obj;
        boolean valueEquals = getValue().equals(testObj.getValue());
        return valueEquals;
    }
    
    @Override // Note: can't check hashCode of parents - causes stack overflow
    public int hashCode()
    {
        int hash = super.hashCode();
        final int prime = 31;
        hash = prime * hash + getValue().hashCode();
        return hash;
    }
    
    /*
     * CONSTRUCTORS
     */
    VParameterBase(StringConverter stringConverter)
    {
    	elementType = VParameterElement.enumFromClass(getClass());
        this.converter = elementType.getConverter();
    }

    VParameterBase(T value, StringConverter stringConverter)
    {
        this(stringConverter);
        setValue(value);
    }

    
    VParameterBase(VParameterBase source, StringConverter stringConverter)
    {
        this(stringConverter);
        setValue(source.getValue());
        setParent(source.getParent());
    }
    
    @Override
    public List errors()
    {
        List errors = new ArrayList<>();
        if (getValue() == null)
        {
            errors.add(name() + " value is null.  The parameter MUST have a value."); 
        }
        return errors;
    }
    
	/*
	 * Get value from a name-value pair separated by an equal sign
	 */
    static String extractValue(String content)
    {
        int equalsIndex = content.indexOf('=');
        final String valueString;
        if (equalsIndex > 0)
        {
            String name = content.substring(0, equalsIndex);
            boolean hasName1 = VParameterElement.enumFromName(name.toUpperCase()) != null;
//            boolean hasName2 = (IANAParameter.getRegisteredIANAParameters() != null) ? IANAParameter.getRegisteredIANAParameters().contains(name.toUpperCase()) : false;
            valueString = (hasName1) ? content.substring(equalsIndex+1) : content;    
        } else
        {
            valueString = content;
        }
        return valueString;
    }
}