Package com.helger.css.media
Class CSSMediaList
- java.lang.Object
-
- com.helger.css.media.CSSMediaList
-
- All Implemented Interfaces:
com.helger.commons.lang.ICloneable<CSSMediaList>
,ICSSMediaList
@NotThreadSafe public class CSSMediaList extends Object implements ICSSMediaList, com.helger.commons.lang.ICloneable<CSSMediaList>
Manages an ordered set ofECSSMedium
objects.- Author:
- Philip Helger
-
-
Field Summary
Fields Modifier and Type Field Description static String
DEFAULT_MEDIA_STRING_SEPARATOR
-
Constructor Summary
Constructors Constructor Description CSSMediaList()
ConstructorCSSMediaList(CSSMediaList aOther)
Copy constructor.CSSMediaList(ECSSMedium eMedium)
Constructor with a single mediumCSSMediaList(ECSSMedium... aMedia)
Constructor with an array of media.CSSMediaList(ICSSMediaList aOther)
Constructor using another media list.CSSMediaList(Iterable<ECSSMedium> aMedia)
Constructor with a collection of media.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description CSSMediaList
addMedia(ECSSMedium... aMediaList)
Add a media list to the listCSSMediaList
addMedia(ICSSMediaList aMediaList)
Add a media list to the listCSSMediaList
addMedia(Iterable<ECSSMedium> aMediaList)
Add a media list to the listCSSMediaList
addMedium(ECSSMedium eMedium)
Add a new medium to the listboolean
containsMedium(ECSSMedium eMedium)
Check if the passed medium is explicitly specifiedstatic CSSMediaList
createOnDemand(ICSSMediaList aMediaList)
boolean
equals(Object o)
com.helger.commons.collection.impl.ICommonsOrderedSet<ECSSMedium>
getAllMedia()
CSSMediaList
getClone()
int
getMediaCount()
String
getMediaString(String sSeparator)
int
hashCode()
boolean
hasNoMedia()
com.helger.commons.state.EChange
removeAllMedia()
Remove all media.com.helger.commons.state.EChange
removeMedium(ECSSMedium eMedium)
Remove the passed mediumString
toString()
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.helger.css.media.ICSSMediaList
containsMediumOrAll, getMediaString, hasAnyMedia, hasNoMediaOrAll, isForScreen
-
-
-
-
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 benull
.
-
CSSMediaList
public CSSMediaList(@Nullable ECSSMedium... aMedia)
Constructor with an array of media.- Parameters:
aMedia
- The array of media to be added. The array may benull
but it may not containnull
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 benull
but it may not containnull
elements.
-
CSSMediaList
public CSSMediaList(@Nonnull ICSSMediaList aOther)
Constructor using another media list.- Parameters:
aOther
- The object to copy from. May not benull
.- Since:
- 3.8.3
-
CSSMediaList
public CSSMediaList(@Nonnull CSSMediaList aOther)
Copy constructor.- Parameters:
aOther
- The object to copy from. May not benull
.
-
-
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 benull
.- 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 benull
.- 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 benull
.- 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 benull
.- 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 benull
.- 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. Nevernull
.- Since:
- 3.7.3
-
getMediaCount
@Nonnegative public int getMediaCount()
- Specified by:
getMediaCount
in interfaceICSSMediaList
- Returns:
- The number of contained media. Always ≥ 0.
-
hasNoMedia
public boolean hasNoMedia()
- Specified by:
hasNoMedia
in interfaceICSSMediaList
- Returns:
true
if no explicit media is defined,false
if a media is defined.
-
containsMedium
public boolean containsMedium(@Nullable ECSSMedium eMedium)
Description copied from interface:ICSSMediaList
Check if the passed medium is explicitly specified- Specified by:
containsMedium
in interfaceICSSMediaList
- Parameters:
eMedium
- The medium to be checked. May benull
.- Returns:
true
if it is contained,false
otherwise
-
getAllMedia
@Nonnull @ReturnsMutableCopy public com.helger.commons.collection.impl.ICommonsOrderedSet<ECSSMedium> getAllMedia()
- Specified by:
getAllMedia
in interfaceICSSMediaList
- Returns:
- A copy of all specified media in the order they were specified.
Never
null
but maybe empty.
-
getMediaString
@Nonnull public String getMediaString(@Nonnull String sSeparator)
- Specified by:
getMediaString
in interfaceICSSMediaList
- Parameters:
sSeparator
- The separator to be used. May not benull
.- 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 interfacecom.helger.commons.lang.ICloneable<CSSMediaList>
-
createOnDemand
@Nonnull @ReturnsMutableCopy public static CSSMediaList createOnDemand(@Nullable ICSSMediaList aMediaList)
-
-