com.helger.css.property

Class CSSPropertyEnum

java.lang.Object

com.helger.css.property.AbstractCSSProperty

com.helger.css.property.CSSPropertyEnum

All Implemented Interfaces:

ICSSVersionAware, ICSSProperty, Serializable

Direct Known Subclasses:

AbstractCSSPropertyEnums, CSSPropertyEnumOrColor, CSSPropertyEnumOrInt, CSSPropertyEnumOrNumber, CSSPropertyEnumOrNumbers, CSSPropertyEnumOrRect, CSSPropertyEnumOrURL

@NotThreadSafe
public class CSSPropertyEnum
extends AbstractCSSProperty

CSS property with a predefined list of possible values (e.g. "cursor")

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CSSPropertyEnum(ECSSProperty eProp, ECSSVendorPrefix eVendorPrefix, ICSSPropertyCustomizer aCustomizer, Iterable<String> aEnumValues)
CSSPropertyEnum(ECSSProperty eProp, ECSSVendorPrefix eVendorPrefix, ICSSPropertyCustomizer aCustomizer, String... aEnumValues)
CSSPropertyEnum(ECSSProperty eProp, ICSSPropertyCustomizer aCustomizer, Iterable<String> aEnumValues)
CSSPropertyEnum(ECSSProperty eProp, ICSSPropertyCustomizer aCustomizer, String... aEnumValues)
CSSPropertyEnum(ECSSProperty eProp, Iterable<String> aEnumValues)
CSSPropertyEnum(ECSSProperty eProp, String... aEnumValues)

Method Summary

Modifier and Type	Method and Description
protected com.helger.commons.collection.impl.ICommonsSet<String>	directGetEnumValues()
boolean	equals(Object o)
CSSPropertyEnum	getClone(ECSSProperty eProp) Get a clone of this property with another (or the same) base property.
CSSPropertyEnum	getClone(ECSSVendorPrefix eVendorPrefix) Get a clone of this property with the same base property but a different vendor prefix.
int	hashCode()
boolean	isValidValue(String sValue) Check if the passed value is valid for this property according to the defined rule.
String	toString()

Methods inherited from class com.helger.css.property.AbstractCSSProperty

getCustomizer, getMaximumArgumentCount, getMinimumArgumentCount, getMinimumCSSVersion, getProp, getPropertyName, getVendorPrefix, isValidPropertyValue, newValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.css.property.ICSSProperty

newImportantValue, newImportantValue, newValue, newValue, newValue

Constructor Detail

CSSPropertyEnum

public CSSPropertyEnum(@Nonnull
                       ECSSProperty eProp,
                       @Nonnull @Nonempty
                       String... aEnumValues)

CSSPropertyEnum

public CSSPropertyEnum(@Nonnull
                       ECSSProperty eProp,
                       @Nullable
                       ICSSPropertyCustomizer aCustomizer,
                       @Nonnull @Nonempty
                       String... aEnumValues)

CSSPropertyEnum

public CSSPropertyEnum(@Nonnull
                       ECSSProperty eProp,
                       @Nullable
                       ECSSVendorPrefix eVendorPrefix,
                       @Nullable
                       ICSSPropertyCustomizer aCustomizer,
                       @Nonnull @Nonempty
                       String... aEnumValues)

CSSPropertyEnum

public CSSPropertyEnum(@Nonnull
                       ECSSProperty eProp,
                       @Nonnull @Nonempty
                       Iterable<String> aEnumValues)

CSSPropertyEnum

public CSSPropertyEnum(@Nonnull
                       ECSSProperty eProp,
                       @Nullable
                       ICSSPropertyCustomizer aCustomizer,
                       @Nonnull @Nonempty
                       Iterable<String> aEnumValues)

CSSPropertyEnum

public CSSPropertyEnum(@Nonnull
                       ECSSProperty eProp,
                       @Nullable
                       ECSSVendorPrefix eVendorPrefix,
                       @Nullable
                       ICSSPropertyCustomizer aCustomizer,
                       @Nonnull @Nonempty
                       Iterable<String> aEnumValues)

Method Detail

directGetEnumValues

@Nonnull
 @ReturnsMutableObject(value="Design")
protected final com.helger.commons.collection.impl.ICommonsSet<String> directGetEnumValues()

Returns:

The Set with the enum values - only used for derived classes. Never null.

isValidValue

@OverridingMethodsMustInvokeSuper
public boolean isValidValue(@Nullable
                                                               String sValue)

Description copied from interface: ICSSProperty

Check if the passed value is valid for this property according to the defined rule.

Specified by:

isValidValue in interface ICSSProperty

Overrides:

isValidValue in class AbstractCSSProperty

Parameters:

sValue - The value to check. May be null.

Returns:

true if the value is valid, false otherwise

getClone

@Nonnull
public CSSPropertyEnum getClone(@Nonnull
                                          ECSSProperty eProp)

Description copied from interface: ICSSProperty

Get a clone of this property with another (or the same) base property.

Parameters:

eProp - The base property to use. May not be null.

Returns:

Never null

getClone

@Nonnull
public CSSPropertyEnum getClone(@Nullable
                                          ECSSVendorPrefix eVendorPrefix)

Description copied from interface: ICSSProperty

Get a clone of this property with the same base property but a different vendor prefix.

Parameters:

eVendorPrefix - The new vendor prefix to use. May be null.

Returns:

Never null

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractCSSProperty

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractCSSProperty

toString

public String toString()

Overrides:

toString in class AbstractCSSProperty