com.helger.css.decl

Class CascadingStyleSheet

java.lang.Object

com.helger.css.decl.CascadingStyleSheet

All Implemented Interfaces:

ICSSSourceLocationAware, Serializable

@NotThreadSafe
public class CascadingStyleSheet
extends Object
implements ICSSSourceLocationAware, Serializable

This is the main object for a parsed CSS declaration. It has special handling for import and namespace rules, as these rules must always be on the beginning of a file. All other rules (all implementing ICSSTopLevelRule) are maintained in a combined list.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CascadingStyleSheet()

Method Summary

Modifier and Type	Method and Description
CascadingStyleSheet	addImportRule(CSSImportRule aImportRule) Add a new @import rule at the end of the @import rule list.
CascadingStyleSheet	addImportRule(int nIndex, CSSImportRule aImportRule) Add a new @import rule at a specified index of the @import rule list.
CascadingStyleSheet	addNamespaceRule(CSSNamespaceRule aNamespaceRule) Add a new @namespace rule at the end of the @namespace rule list.
CascadingStyleSheet	addNamespaceRule(int nIndex, CSSNamespaceRule aNamespaceRule) Add a new @namespace rule at the specified index of the @namespace rule list.
CascadingStyleSheet	addRule(ICSSTopLevelRule aRule) Add a new top-level rule at the end.
CascadingStyleSheet	addRule(int nIndex, ICSSTopLevelRule aRule) Add a new top-level rule at the specified index.
boolean	equals(Object o)
List<CSSFontFaceRule>	getAllFontFaceRules() Get a list of all top-level rules that are font-face rules (implementing CSSFontFaceRule).
List<CSSImportRule>	getAllImportRules()
List<CSSKeyframesRule>	getAllKeyframesRules() Get a list of all top-level rules that are keyframes rules (implementing CSSKeyframesRule).
List<CSSMediaRule>	getAllMediaRules() Get a list of all top-level rules that are media rules (implementing CSSMediaRule).
List<CSSNamespaceRule>	getAllNamespaceRules()
List<CSSPageRule>	getAllPageRules() Get a list of all top-level rules that are page rules (implementing CSSPageRule).
List<ICSSTopLevelRule>	getAllRules() Get a copy of all contained top-level rules.
List<CSSStyleRule>	getAllStyleRules() Get a list of all top-level rules that are style rules (implementing CSSStyleRule).
List<CSSSupportsRule>	getAllSupportsRules() Get a list of all top-level rules that are support rules (implementing CSSSupportsRule).
List<CSSUnknownRule>	getAllUnknownRules() Get a list of all top-level rules that are unknown rules (implementing CSSUnknownRule).
List<CSSViewportRule>	getAllViewportRules() Get a list of all top-level rules that are viewport rules (implementing CSSViewportRule).
CSSFontFaceRule	getFontFaceRuleAtIndex(int nIndex) Get the @font-face rule at the specified index.
int	getFontFaceRuleCount() Get the number of top-level rules that are font-face rules (implementing CSSFontFaceRule).
CSSImportRule	getImportRuleAtIndex(int nIndex) Get the @import rule at the specified index.
int	getImportRuleCount()
CSSKeyframesRule	getKeyframesRuleAtIndex(int nIndex) Get the @keyframes rule at the specified index.
int	getKeyframesRuleCount() Get the number of top-level rules that are keyframes rules (implementing CSSKeyframesRule).
CSSMediaRule	getMediaRuleAtIndex(int nIndex) Get the @media rule at the specified index.
int	getMediaRuleCount() Get the number of top-level rules that are media rules (implementing CSSMediaRule).
CSSNamespaceRule	getNamespaceRuleAtIndex(int nIndex) Get the @namespace rule at the specified index.
int	getNamespaceRuleCount()
CSSPageRule	getPageRuleAtIndex(int nIndex) Get the @page rule at the specified index.
int	getPageRuleCount() Get the number of top-level rules that are page rules (implementing CSSPageRule).
ICSSTopLevelRule	getRuleAtIndex(int nIndex) Get the top-level rule at the specified index.
int	getRuleCount() Get the number of total contained top-level rules.
CSSSourceLocation	getSourceLocation()
CSSStyleRule	getStyleRuleAtIndex(int nIndex) Get the style rule at the specified index.
int	getStyleRuleCount() Get the number of top-level rules that are style rules (implementing CSSStyleRule).
CSSSupportsRule	getSupportsRuleAtIndex(int nIndex) Get the @supports rule at the specified index.
int	getSupportsRuleCount() Get the number of top-level rules that are support rules (implementing CSSSupportsRule).
CSSUnknownRule	getUnknownRuleAtIndex(int nIndex) Get the unknown rule at the specified index.
int	getUnknownRuleCount() Get the number of top-level rules that are unknown rules (implementing CSSUnknownRule).
CSSViewportRule	getViewportRuleAtIndex(int nIndex) Get the @viewport rule at the specified index.
int	getViewportRuleCount() Get the number of top-level rules that are viewport rules (implementing CSSViewportRule).
boolean	hasFontFaceRules() Check if at least one of the top-level rules is a font-face rule (implementing CSSFontFaceRule).
int	hashCode()
boolean	hasImportRules()
boolean	hasKeyframesRules() Check if at least one of the top-level rules is a keyframes rule (implementing CSSKeyframesRule).
boolean	hasMediaRules() Check if at least one of the top-level rules is a media rule (implementing CSSMediaRule).
boolean	hasNamespaceRules()
boolean	hasPageRules() Check if at least one of the top-level rules is a page rule (implementing CSSPageRule).
boolean	hasRules() Check if any top-level rule.
boolean	hasStyleRules() Check if at least one of the top-level rules is a style rule (implementing CSSStyleRule).
boolean	hasSupportsRules() Check if at least one of the top-level rules is a supports rule (implementing CSSSupportsRule).
boolean	hasUnknownRules() Check if at least one of the top-level rules is an unknown rule (implementing CSSUnknownRule).
boolean	hasViewportRules() Check if at least one of the top-level rules is a viewport rule (implementing CSSViewportRule).
com.helger.commons.state.EChange	removeAllImportRules() Remove all @import rules.
com.helger.commons.state.EChange	removeAllNamespaceRules() Remove all @namespace rules.
com.helger.commons.state.EChange	removeAllRules() Remove all top-level rules.
com.helger.commons.state.EChange	removeImportRule(CSSImportRule aImportRule) Remove the specified @import rule.
com.helger.commons.state.EChange	removeImportRule(int nImportRuleIndex) Remove the @import rule at the specified index.
com.helger.commons.state.EChange	removeNamespaceRule(CSSNamespaceRule aNamespaceRule) Remove the specified @namespace rule.
com.helger.commons.state.EChange	removeNamespaceRule(int nNamespaceRuleIndex) Remove the @namespace rule at the specified index.
com.helger.commons.state.EChange	removeRule(ICSSTopLevelRule aRule) Remove the specified top-level rule.
com.helger.commons.state.EChange	removeRule(int nRuleIndex) Remove the rule at the specified index.
void	setSourceLocation(CSSSourceLocation aSourceLocation) Set the source location of the object, determined while parsing.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CascadingStyleSheet

public CascadingStyleSheet()

Method Detail

hasImportRules

public boolean hasImportRules()

Returns:

true if at least one @import rule is present, false otherwise.

getImportRuleCount

@Nonnegative
public int getImportRuleCount()

Returns:

The number of contained @import rules. Always ≥ 0.

getImportRuleAtIndex

@Nullable
public CSSImportRule getImportRuleAtIndex(@Nonnegative
                                                     int nIndex)

Get the @import rule at the specified index.

Parameters:

nIndex - The index to be resolved. Should be ≥ 0 and < getImportRuleCount().

Returns:

null if an invalid index was specified.

Since:

3.7.4

addImportRule

@Nonnull
public CascadingStyleSheet addImportRule(@Nonnull
                                                   CSSImportRule aImportRule)

Add a new @import rule at the end of the @import rule list.

Parameters:

aImportRule - The import rule to add. May not be null.

Returns:

this

addImportRule

@Nonnull
public CascadingStyleSheet addImportRule(@Nonnegative
                                                   int nIndex,
                                                   @Nonnull
                                                   CSSImportRule aImportRule)

Add a new @import rule at a specified index of the @import rule list.

Parameters:

nIndex - The index where the rule should be added. Must be ≥ 0.

aImportRule - The import rule to add. May not be null.

Returns:

this

Throws:

ArrayIndexOutOfBoundsException - if the index is invalid

removeImportRule

@Nonnull
public com.helger.commons.state.EChange removeImportRule(@Nullable
                                                                   CSSImportRule aImportRule)

Remove the specified @import rule.

Parameters:

aImportRule - The import rule to be removed. May be null.

Returns:

EChange.CHANGED if removal was successful, EChange.UNCHANGED otherwise. Never null.

removeImportRule

@Nonnull
public com.helger.commons.state.EChange removeImportRule(@Nonnegative
                                                                   int nImportRuleIndex)

Remove the @import rule at the specified index.

Parameters:

nImportRuleIndex - The index to be removed. Should be ≥ 0.

Returns:

EChange.CHANGED if removal was successful, EChange.UNCHANGED otherwise. Never null.

removeAllImportRules

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

Remove all @import rules.

Returns:

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

Since:

3.7.3

getAllImportRules

@Nonnull
 @ReturnsMutableCopy
public List<CSSImportRule> getAllImportRules()

Returns:

A copy of all contained @import rules. Never null.

hasNamespaceRules

public boolean hasNamespaceRules()

Returns:

true if at least one @namespace rule is present, false otherwise.

getNamespaceRuleCount

@Nonnegative
public int getNamespaceRuleCount()

Returns:

The number of contained @namespace rules. Always ≥ 0.

getNamespaceRuleAtIndex

@Nullable
public CSSNamespaceRule getNamespaceRuleAtIndex(@Nonnegative
                                                           int nIndex)

Get the @namespace rule at the specified index.

Parameters:

nIndex - The index to be resolved. Should be ≥ 0 and < getNamespaceRuleCount().

Returns:

null if an invalid index was specified.

Since:

3.7.4

addNamespaceRule

@Nonnull
public CascadingStyleSheet addNamespaceRule(@Nonnull
                                                      CSSNamespaceRule aNamespaceRule)

Add a new @namespace rule at the end of the @namespace rule list.

Parameters:

aNamespaceRule - The namespace rule to be added. May not be null.

Returns:

this

addNamespaceRule

@Nonnull
public CascadingStyleSheet addNamespaceRule(@Nonnegative
                                                      int nIndex,
                                                      @Nonnull
                                                      CSSNamespaceRule aNamespaceRule)

Add a new @namespace rule at the specified index of the @namespace rule list.

Parameters:

nIndex - The index where the rule should be added. Must be ≥ 0.

aNamespaceRule - The namespace rule to be added. May not be null.

Returns:

this

removeNamespaceRule

@Nonnull
public com.helger.commons.state.EChange removeNamespaceRule(@Nullable
                                                                      CSSNamespaceRule aNamespaceRule)

Remove the specified @namespace rule.

Parameters:

aNamespaceRule - The namespace rule to be removed. May be null.

Returns:

EChange.CHANGED if the namespace rule was successfully removed, EChange.UNCHANGED otherwise. Never null.

removeNamespaceRule

@Nonnull
public com.helger.commons.state.EChange removeNamespaceRule(@Nonnegative
                                                                      int nNamespaceRuleIndex)

Remove the @namespace rule at the specified index.

Parameters:

nNamespaceRuleIndex - The index to be removed. Should be ≥ 0.

Returns:

EChange.CHANGED if the namespace rule was successfully removed, EChange.UNCHANGED otherwise. Never null.

removeAllNamespaceRules

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

Remove all @namespace rules.

Returns:

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

Since:

3.7.3

getAllNamespaceRules

@Nonnull
 @ReturnsMutableCopy
public List<CSSNamespaceRule> getAllNamespaceRules()

Returns:

A copy of all @namespace rules. Never null.

hasRules

public boolean hasRules()

Check if any top-level rule. This method only considers top-level rules and not @import and @namespace rules!

Returns:

true if at least one top-level rule is present, false if otherwise.

getRuleCount

@Nonnegative
public int getRuleCount()

Get the number of total contained top-level rules. This method only considers top-level rules and not @import and @namespace rules!

Returns:

The number of total contained top-level rules. Always ≥ 0.

getRuleAtIndex

@Nullable
public ICSSTopLevelRule getRuleAtIndex(@Nonnegative
                                                  int nIndex)

Get the top-level rule at the specified index.

Parameters:

nIndex - The index to be resolved. Should be ≥ 0 and < getRuleCount().

Returns:

null if an invalid index was specified.

Since:

3.7.4

addRule

@Nonnull
public CascadingStyleSheet addRule(@Nonnull
                                             ICSSTopLevelRule aRule)

Add a new top-level rule at the end. This method only considers top-level rules and not @import and @namespace rules!

Parameters:

aRule - The rule to be added. May not be null.

Returns:

this

addRule

@Nonnull
public CascadingStyleSheet addRule(@Nonnegative
                                             int nIndex,
                                             @Nonnull
                                             ICSSTopLevelRule aRule)

Add a new top-level rule at the specified index. This method only considers top-level rules and not @import and @namespace rules!

Parameters:

nIndex - The index where the top-level rule should be added. Must be ≥ 0.

aRule - The rule to be added. May not be null.

Returns:

this

removeRule

@Nonnull
public com.helger.commons.state.EChange removeRule(@Nullable
                                                             ICSSTopLevelRule aRule)

Remove the specified top-level rule. This method only considers top-level rules and not @import and @namespace rules!

Parameters:

aRule - The rule to be removed. May be null.

Returns:

EChange.CHANGED if the rule was successfully removed, EChange.UNCHANGED otherwise. Never null.

removeRule

@Nonnull
public com.helger.commons.state.EChange removeRule(@Nonnegative
                                                             int nRuleIndex)

Remove the rule at the specified index. This method only considers top-level rules and not @import and @namespace rules!

Parameters:

nRuleIndex - The index of the rule to be removed. Should be ≥ 0.

Returns:

EChange.CHANGED if the rule at the specified index was successfully removed, EChange.UNCHANGED otherwise. Never null.

removeAllRules

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

Remove all top-level rules.

Returns:

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

Since:

3.7.3

getAllRules

@Nonnull
 @ReturnsMutableCopy
public List<ICSSTopLevelRule> getAllRules()

Get a copy of all contained top-level rules. This method only considers top-level rules and not @import and @namespace rules!

Returns:

A copy of all contained top-level rules. Never null.

hasStyleRules

public boolean hasStyleRules()

Check if at least one of the top-level rules is a style rule (implementing CSSStyleRule).

Returns:

true if at least one style rule is contained, false otherwise.

getStyleRuleCount

@Nonnegative
public int getStyleRuleCount()

Get the number of top-level rules that are style rules (implementing CSSStyleRule).

Returns:

The number of contained style rules. Always ≥ 0.

getStyleRuleAtIndex

@Nullable
public CSSStyleRule getStyleRuleAtIndex(@Nonnegative
                                                   int nIndex)

Get the style rule at the specified index.

Parameters:

nIndex - The index to be resolved. Should be ≥ 0 and < getStyleRuleCount().

Returns:

null if an invalid index was specified.

Since:

3.7.4

getAllStyleRules

@Nonnull
 @ReturnsMutableCopy
public List<CSSStyleRule> getAllStyleRules()

Get a list of all top-level rules that are style rules (implementing CSSStyleRule).

Returns:

A copy of all contained style rules. Never null.

hasPageRules

public boolean hasPageRules()

Check if at least one of the top-level rules is a page rule (implementing CSSPageRule).

Returns:

true if at least one @page rule is contained, false otherwise.

getPageRuleCount

@Nonnegative
public int getPageRuleCount()

Get the number of top-level rules that are page rules (implementing CSSPageRule).

Returns:

The number of contained @page rules. Always ≥ 0.

getPageRuleAtIndex

@Nullable
public CSSPageRule getPageRuleAtIndex(@Nonnegative
                                                 int nIndex)

Get the @page rule at the specified index.

Parameters:

nIndex - The index to be resolved. Should be ≥ 0 and < getPageRuleCount().

Returns:

null if an invalid index was specified.

Since:

3.7.4

getAllPageRules

@Nonnull
 @ReturnsMutableCopy
public List<CSSPageRule> getAllPageRules()

Get a list of all top-level rules that are page rules (implementing CSSPageRule).

Returns:

A copy of all contained @page rules. Never null.

hasMediaRules

public boolean hasMediaRules()

Check if at least one of the top-level rules is a media rule (implementing CSSMediaRule).

Returns:

true if at least one @media rule is contained, false otherwise.

getMediaRuleCount

@Nonnegative
public int getMediaRuleCount()

Get the number of top-level rules that are media rules (implementing CSSMediaRule).

Returns:

The number of contained @media rules. Always ≥ 0.

getMediaRuleAtIndex

@Nullable
public CSSMediaRule getMediaRuleAtIndex(@Nonnegative
                                                   int nIndex)

Get the @media rule at the specified index.

Parameters:

nIndex - The index to be resolved. Should be ≥ 0 and < getMediaRuleCount().

Returns:

null if an invalid index was specified.

Since:

3.7.4

getAllMediaRules

@Nonnull
 @ReturnsMutableCopy
public List<CSSMediaRule> getAllMediaRules()

Get a list of all top-level rules that are media rules (implementing CSSMediaRule).

Returns:

A copy of all contained @media rules. Never null.

hasFontFaceRules

public boolean hasFontFaceRules()

Check if at least one of the top-level rules is a font-face rule (implementing CSSFontFaceRule).

Returns:

true if at least one @font-face rule is contained, false otherwise.

getFontFaceRuleCount

@Nonnegative
public int getFontFaceRuleCount()

Get the number of top-level rules that are font-face rules (implementing CSSFontFaceRule).

Returns:

The number of contained @font-face rules. Always ≥ 0.

getFontFaceRuleAtIndex

@Nullable
public CSSFontFaceRule getFontFaceRuleAtIndex(@Nonnegative
                                                         int nIndex)

Get the @font-face rule at the specified index.

Parameters:

nIndex - The index to be resolved. Should be ≥ 0 and < getFontFaceRuleCount().

Returns:

null if an invalid index was specified.

Since:

3.7.4

getAllFontFaceRules

@Nonnull
 @ReturnsMutableCopy
public List<CSSFontFaceRule> getAllFontFaceRules()

Get a list of all top-level rules that are font-face rules (implementing CSSFontFaceRule).

Returns:

A copy of all contained @font-face rules. Never null.

hasKeyframesRules

public boolean hasKeyframesRules()

Check if at least one of the top-level rules is a keyframes rule (implementing CSSKeyframesRule).

Returns:

true if at least one @keyframes rule is contained, false otherwise.

getKeyframesRuleCount

@Nonnegative
public int getKeyframesRuleCount()

Get the number of top-level rules that are keyframes rules (implementing CSSKeyframesRule).

Returns:

The number of contained @keyframes rules. Always ≥ 0.

getKeyframesRuleAtIndex

@Nullable
public CSSKeyframesRule getKeyframesRuleAtIndex(@Nonnegative
                                                           int nIndex)

Get the @keyframes rule at the specified index.

Parameters:

nIndex - The index to be resolved. Should be ≥ 0 and < getKeyframesRuleCount().

Returns:

null if an invalid index was specified.

Since:

3.7.4

getAllKeyframesRules

@Nonnull
 @ReturnsMutableCopy
public List<CSSKeyframesRule> getAllKeyframesRules()

Get a list of all top-level rules that are keyframes rules (implementing CSSKeyframesRule).

Returns:

A copy of all contained @keyframes rules. Never null.

hasViewportRules

public boolean hasViewportRules()

Check if at least one of the top-level rules is a viewport rule (implementing CSSViewportRule).

Returns:

true if at least one @viewport rule is contained, false otherwise.

getViewportRuleCount

@Nonnegative
public int getViewportRuleCount()

Get the number of top-level rules that are viewport rules (implementing CSSViewportRule).

Returns:

The number of contained @viewport rules. Always ≥ 0.

getViewportRuleAtIndex

@Nullable
public CSSViewportRule getViewportRuleAtIndex(@Nonnegative
                                                         int nIndex)

Get the @viewport rule at the specified index.

Parameters:

nIndex - The index to be resolved. Should be ≥ 0 and < getViewportRuleCount().

Returns:

null if an invalid index was specified.

Since:

3.7.4

getAllViewportRules

@Nonnull
 @ReturnsMutableCopy
public List<CSSViewportRule> getAllViewportRules()

Get a list of all top-level rules that are viewport rules (implementing CSSViewportRule).

Returns:

A copy of all contained @viewport rules. Never null.

hasSupportsRules

public boolean hasSupportsRules()

Check if at least one of the top-level rules is a supports rule (implementing CSSSupportsRule).

Returns:

true if at least one @supports rule is contained, false otherwise.

getSupportsRuleCount

@Nonnegative
public int getSupportsRuleCount()

Get the number of top-level rules that are support rules (implementing CSSSupportsRule).

Returns:

The number of contained @supports rules. Always ≥ 0.

getSupportsRuleAtIndex

@Nullable
public CSSSupportsRule getSupportsRuleAtIndex(@Nonnegative
                                                         int nIndex)

Get the @supports rule at the specified index.

Parameters:

nIndex - The index to be resolved. Should be ≥ 0 and < getSupportsRuleCount().

Returns:

null if an invalid index was specified.

Since:

3.7.4

getAllSupportsRules

@Nonnull
 @ReturnsMutableCopy
public List<CSSSupportsRule> getAllSupportsRules()

Get a list of all top-level rules that are support rules (implementing CSSSupportsRule).

Returns:

A copy of all contained @supports rules. Never null.

hasUnknownRules

public boolean hasUnknownRules()

Check if at least one of the top-level rules is an unknown rule (implementing CSSUnknownRule).

Returns:

true if at least one unknown @ rule is contained, false otherwise.

getUnknownRuleCount

@Nonnegative
public int getUnknownRuleCount()

Get the number of top-level rules that are unknown rules (implementing CSSUnknownRule).

Returns:

The number of contained unknown @ rules. Always ≥ 0.

getUnknownRuleAtIndex

@Nullable
public CSSUnknownRule getUnknownRuleAtIndex(@Nonnegative
                                                       int nIndex)

Get the unknown rule at the specified index.

Parameters:

nIndex - The index to be resolved. Should be ≥ 0 and < getUnknownRuleCount().

Returns:

null if an invalid index was specified.

Since:

3.7.4

getAllUnknownRules

@Nonnull
 @ReturnsMutableCopy
public List<CSSUnknownRule> getAllUnknownRules()

Get a list of all top-level rules that are unknown rules (implementing CSSUnknownRule).

Returns:

A copy of all contained unknown @ rules. Never null.

setSourceLocation

public void setSourceLocation(@Nullable
                              CSSSourceLocation aSourceLocation)

Description copied from interface: ICSSSourceLocationAware

Set the source location of the object, determined while parsing.

Specified by:

setSourceLocation in interface ICSSSourceLocationAware

Parameters:

aSourceLocation - The source location to use. May be null.

getSourceLocation

@Nullable
public CSSSourceLocation getSourceLocation()

Specified by:

getSourceLocation in interface ICSSSourceLocationAware

Returns:

The source location of this object when it was read by the parser. May be null if an object was not read but manually created.

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