com.helger.css.media

Class CSSMediaList

java.lang.Object

com.helger.css.media.CSSMediaList

All Implemented Interfaces:

com.helger.commons.lang.ICloneable<CSSMediaList>, ICSSMediaList, Serializable

@NotThreadSafe
public class CSSMediaList
extends Object
implements ICSSMediaList, com.helger.commons.lang.ICloneable<CSSMediaList>

Manages an ordered set of ECSSMedium objects.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_MEDIA_STRING_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
CSSMediaList() Constructor
CSSMediaList(CSSMediaList aOther) Copy constructor.
CSSMediaList(ECSSMedium... aMedia) Constructor with an array of media.
CSSMediaList(ECSSMedium eMedium) Constructor with a single medium
CSSMediaList(ICSSMediaList aOther) Constructor using another media list.
CSSMediaList(Iterable<ECSSMedium> aMedia) Constructor with a collection of media.

Method Summary

Modifier and Type	Method and Description
CSSMediaList	addMedia(ECSSMedium... aMediaList) Add a media list to the list
CSSMediaList	addMedia(ICSSMediaList aMediaList) Add a media list to the list
CSSMediaList	addMedia(Iterable<ECSSMedium> aMediaList) Add a media list to the list
CSSMediaList	addMedium(ECSSMedium eMedium) Add a new medium to the list
boolean	containsMedium(ECSSMedium eMedium) Check if the passed medium is explicitly specified
boolean	containsMediumOrAll(ECSSMedium eMedium) Check if the passed medium or the ECSSMedium.ALL is explicitly specified
static CSSMediaList	createOnDemand(ICSSMediaList aMediaList)
boolean	equals(Object o)
Set<ECSSMedium>	getAllMedia()
CSSMediaList	getClone()
int	getMediaCount()
String	getMediaString()
String	getMediaString(String sSeparator)
boolean	hasAnyMedia()
int	hashCode()
boolean	hasNoMedia()
boolean	hasNoMediaOrAll()
boolean	isForScreen() Check if the passed medium is usable for the screen.
com.helger.commons.state.EChange	removeAllMedia() Remove all media.
com.helger.commons.state.EChange	removeMedium(ECSSMedium eMedium) Remove the passed medium
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MEDIA_STRING_SEPARATOR

public static final String DEFAULT_MEDIA_STRING_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

CSSMediaList

public CSSMediaList()

Constructor

CSSMediaList

public CSSMediaList(@Nonnull
                    ECSSMedium eMedium)

Constructor with a single medium

Parameters:

eMedium - The medium to be added. May not be null.

CSSMediaList

public CSSMediaList(@Nullable
                    ECSSMedium... aMedia)

Constructor with an array of media.

Parameters:

aMedia - The array of media to be added. The array may be null but it may not contain null elements.

CSSMediaList

public CSSMediaList(@Nullable
                    Iterable<ECSSMedium> aMedia)

Constructor with a collection of media.

Parameters:

aMedia - The collection of media to be added. The collection may be null but it may not contain null elements.

CSSMediaList

public CSSMediaList(@Nonnull
                    ICSSMediaList aOther)

Constructor using another media list.

Parameters:

aOther - The object to copy from. May not be null.

Since:

3.8.3

CSSMediaList

public CSSMediaList(@Nonnull
                    CSSMediaList aOther)

Copy constructor.

Parameters:

aOther - The object to copy from. May not be null.

Method Detail

addMedium

@Nonnull
public CSSMediaList addMedium(@Nonnull
                                        ECSSMedium eMedium)

Add a new medium to the list

Parameters:

eMedium - The medium to be added. May not be null.

Returns:

this

addMedia

@Nonnull
public CSSMediaList addMedia(@Nonnull
                                       ECSSMedium... aMediaList)

Add a media list to the list

Parameters:

aMediaList - The media list to be added. May not be null.

Returns:

this

Since:

3.8.3

addMedia

@Nonnull
public CSSMediaList addMedia(@Nonnull
                                       ICSSMediaList aMediaList)

Add a media list to the list

Parameters:

aMediaList - The media list to be added. May not be null.

Returns:

this

Since:

3.8.3

addMedia

@Nonnull
public CSSMediaList addMedia(@Nonnull
                                       Iterable<ECSSMedium> aMediaList)

Add a media list to the list

Parameters:

aMediaList - The media list to be added. May not be null.

Returns:

this

Since:

3.8.3

removeMedium

@Nonnull
public com.helger.commons.state.EChange removeMedium(@Nullable
                                                               ECSSMedium eMedium)

Remove the passed medium

Parameters:

eMedium - The medium to be removed. May be null.

Returns:

EChange.CHANGED if the medium was removed, EChange.UNCHANGED otherwise.

removeAllMedia

@Nonnull
public com.helger.commons.state.EChange removeAllMedia()

Remove all media.

Returns:

EChange.CHANGED if any medium was removed, EChange.UNCHANGED otherwise. Never null.

Since:

3.7.3

getMediaCount

@Nonnegative
public int getMediaCount()

Specified by:

getMediaCount in interface ICSSMediaList

Returns:

The number of contained media. Always ≥ 0.

hasAnyMedia

public boolean hasAnyMedia()

Specified by:

hasAnyMedia in interface ICSSMediaList

Returns:

true if any explicit media is defined, false if not.

hasNoMedia

public boolean hasNoMedia()

Specified by:

hasNoMedia in interface ICSSMediaList

Returns:

true if no explicit media is defined, false if a media is defined.

hasNoMediaOrAll

public boolean hasNoMediaOrAll()

Specified by:

hasNoMediaOrAll in interface ICSSMediaList

Returns:

true if no explicit media is defined or if ECSSMedium.ALL is contained.

containsMedium

public boolean containsMedium(@Nullable
                              ECSSMedium eMedium)

Description copied from interface: ICSSMediaList

Check if the passed medium is explicitly specified

Specified by:

containsMedium in interface ICSSMediaList

Parameters:

eMedium - The medium to be checked. May be null.

Returns:

true if it is contained, false otherwise

containsMediumOrAll

public boolean containsMediumOrAll(@Nullable
                                   ECSSMedium eMedium)

Description copied from interface: ICSSMediaList

Check if the passed medium or the ECSSMedium.ALL is explicitly specified

Specified by:

containsMediumOrAll in interface ICSSMediaList

Parameters:

eMedium - The medium to be checked. May be null.

Returns:

true if the passed medium or the "all" medium is contained, false otherwise

isForScreen

public boolean isForScreen()

Description copied from interface: ICSSMediaList

Check if the passed medium is usable for the screen. This is the case if either the "screen" medium, the "all" medium or no medium at all is contained.

Specified by:

isForScreen in interface ICSSMediaList

Returns:

true if the media list is usable for screen display

getAllMedia

@Nonnull
 @ReturnsMutableCopy
public Set<ECSSMedium> getAllMedia()

Specified by:

getAllMedia in interface ICSSMediaList

Returns:

A copy of all specified media in the order they were specified. Never null but maybe empty.

getMediaString

@Nonnull
public String getMediaString()

Specified by:

getMediaString in interface ICSSMediaList

Returns:

A non-null but maybe empty String with all media in the order they where inserted and separated by

See Also:

ICSSMediaList.getMediaString(String)

getMediaString

@Nonnull
public String getMediaString(@Nonnull
                                       String sSeparator)

Specified by:

getMediaString in interface ICSSMediaList

Parameters:

sSeparator - The separator to be used. May not be null.

Returns:

A non-null but maybe empty String with all media in the order they where inserted and separated by the specified separator

getClone

@Nonnull
 @ReturnsMutableCopy
public CSSMediaList getClone()

Specified by:

getClone in interface com.helger.commons.lang.ICloneable<CSSMediaList>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

createOnDemand

@Nonnull
 @ReturnsMutableCopy
public static CSSMediaList createOnDemand(@Nullable
                                                                          ICSSMediaList aMediaList)