CSSReader (ph-css 6.2.3 API)

java.lang.Object
- com.helger.css.reader.CSSReader

```
@ThreadSafe
public final class CSSReader
extends Object
```
This is the central user class for reading and parsing CSS from different sources. This class reads full CSS declarations only. To read only a declaration list (like from an HTML <style> attribute) the CSSReaderDeclarationList is available.

Author:

Philip Helger

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Charset`	`getCharsetDeclaredInCSS(com.helger.commons.io.IHasInputStream aISP)` Determine the charset to read the CSS file.
`static ICSSInterpretErrorHandler`	`getDefaultInterpretErrorHandler()`
`static ICSSParseErrorHandler`	`getDefaultParseErrorHandler()`
`static ICSSParseExceptionCallback`	`getDefaultParseExceptionHandler()`
`static boolean`	`isValidCSS(File aFile, Charset aFallbackCharset, ECSSVersion eVersion)` Check if the passed CSS file can be parsed without error
`static boolean`	`isValidCSS(InputStream aIS, Charset aFallbackCharset, ECSSVersion eVersion)` Check if the passed input stream can be resembled to valid CSS content.
`static boolean`	`isValidCSS(com.helger.commons.io.resource.IReadableResource aRes, Charset aFallbackCharset, ECSSVersion eVersion)` Check if the passed CSS resource can be parsed without error
`static boolean`	`isValidCSS(Reader aReader, ECSSVersion eVersion)` Check if the passed reader can be resembled to valid CSS content.
`static boolean`	`isValidCSS(String sCSS, ECSSVersion eVersion)` Check if the passed String can be resembled to valid CSS content.
`static CascadingStyleSheet`	`readFromFile(File aFile, Charset aFallbackCharset, ECSSVersion eVersion)` Read the CSS from the passed File.
`static CascadingStyleSheet`	`readFromFile(File aFile, Charset aFallbackCharset, ECSSVersion eVersion, ICSSParseErrorHandler aCustomErrorHandler)` Read the CSS from the passed File.
`static CascadingStyleSheet`	`readFromFile(File aFile, Charset aFallbackCharset, ECSSVersion eVersion, ICSSParseErrorHandler aCustomErrorHandler, ICSSParseExceptionCallback aCustomExceptionHandler)` Read the CSS from the passed File.
`static CascadingStyleSheet`	`readFromFile(File aFile, Charset aFallbackCharset, ECSSVersion eVersion, ICSSParseExceptionCallback aCustomExceptionHandler)` Read the CSS from the passed File.
`static CascadingStyleSheet`	`readFromFile(File aFile, CSSReaderSettings aSettings)` Read the CSS from the passed File.
`static CascadingStyleSheet`	`readFromReader(com.helger.commons.io.IHasReader aRP, CSSReaderSettings aSettings)` Read the CSS from the passed `IReaderProvider`.
`static CascadingStyleSheet`	`readFromReader(com.helger.commons.io.IHasReader aRP, ECSSVersion eVersion, ICSSParseErrorHandler aCustomErrorHandler, ICSSParseExceptionCallback aCustomExceptionHandler)` Read the CSS from the passed `IReaderProvider`.
`static CascadingStyleSheet`	`readFromStream(com.helger.commons.io.IHasInputStream aISP, Charset aFallbackCharset, ECSSVersion eVersion)` Read the CSS from the passed `IHasInputStream`.
`static CascadingStyleSheet`	`readFromStream(com.helger.commons.io.IHasInputStream aISP, Charset aFallbackCharset, ECSSVersion eVersion, ICSSParseErrorHandler aCustomErrorHandler)` Read the CSS from the passed `IHasInputStream`.
`static CascadingStyleSheet`	`readFromStream(com.helger.commons.io.IHasInputStream aISP, Charset aFallbackCharset, ECSSVersion eVersion, ICSSParseErrorHandler aCustomErrorHandler, ICSSParseExceptionCallback aCustomExceptionHandler)` Read the CSS from the passed `IHasInputStream`.
`static CascadingStyleSheet`	`readFromStream(com.helger.commons.io.IHasInputStream aISP, Charset aFallbackCharset, ECSSVersion eVersion, ICSSParseExceptionCallback aCustomExceptionHandler)` Read the CSS from the passed `IHasInputStream`.
`static CascadingStyleSheet`	`readFromStream(com.helger.commons.io.IHasInputStream aISP, CSSReaderSettings aSettings)` Read the CSS from the passed `IHasInputStream`.
`static CascadingStyleSheet`	`readFromString(String sCSS, Charset aFallbackCharset, ECSSVersion eVersion)` Read the CSS from the passed String using a byte stream.
`static CascadingStyleSheet`	`readFromString(String sCSS, Charset aFallbackCharset, ECSSVersion eVersion, ICSSParseErrorHandler aCustomErrorHandler)` Read the CSS from the passed String using a byte stream.
`static CascadingStyleSheet`	`readFromString(String sCSS, Charset aFallbackCharset, ECSSVersion eVersion, ICSSParseErrorHandler aCustomErrorHandler, ICSSParseExceptionCallback aCustomExceptionHandler)` Read the CSS from the passed String using a byte stream.
`static CascadingStyleSheet`	`readFromString(String sCSS, Charset aFallbackCharset, ECSSVersion eVersion, ICSSParseExceptionCallback aCustomExceptionHandler)` Read the CSS from the passed String using a byte stream.
`static CascadingStyleSheet`	`readFromString(String sCSS, ECSSVersion eVersion)` Read the CSS from the passed String using a character stream.
`static CascadingStyleSheet`	`readFromString(String sCSS, ECSSVersion eVersion, ICSSParseErrorHandler aCustomErrorHandler)` Read the CSS from the passed String using a character stream.
`static CascadingStyleSheet`	`readFromString(String sCSS, ECSSVersion eVersion, ICSSParseErrorHandler aCustomErrorHandler, ICSSParseExceptionCallback aCustomExceptionHandler)` Read the CSS from the passed String using a character stream.
`static CascadingStyleSheet`	`readFromString(String sCSS, ECSSVersion eVersion, ICSSParseExceptionCallback aCustomExceptionHandler)` Read the CSS from the passed String using a character stream.
`static CascadingStyleSheet`	`readFromStringReader(String sCSS, CSSReaderSettings aSettings)` Read the CSS from the passed String using a character stream.
`static CascadingStyleSheet`	`readFromStringStream(String sCSS, CSSReaderSettings aSettings)` Read the CSS from the passed String using a byte stream.
`static void`	`setDefaultInterpretErrorHandler(ICSSInterpretErrorHandler aDefaultErrorHandler)` Set the default interpret error handler to handle interpretation errors in successfully parsed CSS.
`static void`	`setDefaultParseErrorHandler(ICSSParseErrorHandler aDefaultParseErrorHandler)` Set the default CSS parse error handler (for recoverable errors).
`static void`	`setDefaultParseExceptionHandler(ICSSParseExceptionCallback aDefaultParseExceptionHandler)` Set the default CSS parse exception handler (for unrecoverable errors).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getDefaultParseErrorHandler
```
@Nullable
public static ICSSParseErrorHandler getDefaultParseErrorHandler()
```
Returns:

The default CSS parse error handler. May be null. For backwards compatibility reasons this is be default an instance of ThrowingCSSParseErrorHandler.

setDefaultParseErrorHandler
```
public static void setDefaultParseErrorHandler(@Nullable
                                               ICSSParseErrorHandler aDefaultParseErrorHandler)
```
Set the default CSS parse error handler (for recoverable errors).

Parameters:

aDefaultParseErrorHandler - The new default error handler to be used. May be null to indicate that no special error handler should be used.

getDefaultParseExceptionHandler
```
@Nonnull
public static ICSSParseExceptionCallback getDefaultParseExceptionHandler()
```
Returns:

The default CSS parse exception handler. May not be null. For backwards compatibility reasons this is be default an instance of LoggingCSSParseExceptionCallback.

Since:

3.7.4

setDefaultParseExceptionHandler

public static void setDefaultParseExceptionHandler(@Nonnull
                                                   ICSSParseExceptionCallback aDefaultParseExceptionHandler)

Set the default CSS parse exception handler (for unrecoverable errors).

Parameters:: aDefaultParseExceptionHandler - The new default exception handler to be used. May not be null.
Since:: 3.7.4

getDefaultInterpretErrorHandler
```
@Nonnull
public static ICSSInterpretErrorHandler getDefaultInterpretErrorHandler()
```
Returns:

The default interpret error handler to handle interpretation errors in successfully parsed CSS. Never null.

Since:

5.0.2

setDefaultInterpretErrorHandler
```
public static void setDefaultInterpretErrorHandler(@Nonnull
                                                   ICSSInterpretErrorHandler aDefaultErrorHandler)
```
Set the default interpret error handler to handle interpretation errors in successfully parsed CSS.

Parameters:

aDefaultErrorHandler - The default error handler to be used. May not be null.

Since:

5.0.2

isValidCSS

public static boolean isValidCSS(@Nonnull
                                 File aFile,
                                 @Nonnull
                                 Charset aFallbackCharset,
                                 @Nonnull
                                 ECSSVersion eVersion)

Check if the passed CSS file can be parsed without error

Parameters:: aFile - The file to be parsed. May not be null.; aFallbackCharset - The charset to be used for reading the CSS file in case neither a @charset rule nor a BOM is present. May not be null.; eVersion - The CSS version to be used for scanning. May not be null.
Returns:: true if the file can be parsed without error, false if not

isValidCSS

public static boolean isValidCSS(@Nonnull
                                 com.helger.commons.io.resource.IReadableResource aRes,
                                 @Nonnull
                                 Charset aFallbackCharset,
                                 @Nonnull
                                 ECSSVersion eVersion)

Check if the passed CSS resource can be parsed without error

Parameters:: aRes - The resource to be parsed. May not be null.; aFallbackCharset - The charset to be used for reading the CSS file in case neither a @charset rule nor a BOM is present. May not be null.; eVersion - The CSS version to be used for scanning. May not be null.
Returns:: true if the file can be parsed without error, false if not

isValidCSS
```
public static boolean isValidCSS(@Nonnull @WillClose
                                 InputStream aIS,
                                 @Nonnull
                                 Charset aFallbackCharset,
                                 @Nonnull
                                 ECSSVersion eVersion)
```
Check if the passed input stream can be resembled to valid CSS content. This is accomplished by fully parsing the CSS file each time the method is called. This is similar to calling readFromStream(IHasInputStream,Charset, ECSSVersion) and checking for a non-null result.

Parameters:

aIS - The input stream to use. Is automatically closed. May not be null.

aFallbackCharset - The charset to be used in case neither a @charset rule nor a BOM is present. May not be null.

eVersion - The CSS version to use. May not be null.

Returns:

true if the CSS is valid according to the version, false if not

isValidCSS
```
public static boolean isValidCSS(@Nonnull
                                 String sCSS,
                                 @Nonnull
                                 ECSSVersion eVersion)
```
Check if the passed String can be resembled to valid CSS content. This is accomplished by fully parsing the CSS file each time the method is called. This is similar to calling readFromString(String, Charset, ECSSVersion) and checking for a non-null result.

Parameters:

sCSS - The CSS string to scan. May not be null.

eVersion - The CSS version to use. May not be null.

Returns:

true if the CSS is valid according to the version, false if not

isValidCSS
```
public static boolean isValidCSS(@Nonnull @WillClose
                                 Reader aReader,
                                 @Nonnull
                                 ECSSVersion eVersion)
```
Check if the passed reader can be resembled to valid CSS content. This is accomplished by fully parsing the CSS each time the method is called. This is similar to calling readFromStream(IHasInputStream, Charset, ECSSVersion) and checking for a non-null result.

Parameters:

aReader - The reader to use. May not be null.

eVersion - The CSS version to use. May not be null.

Returns:

true if the CSS is valid according to the version, false if not

readFromString

@Nullable
public static CascadingStyleSheet readFromString(@Nonnull
                                                            String sCSS,
                                                            @Nonnull
                                                            Charset aFallbackCharset,
                                                            @Nonnull
                                                            ECSSVersion eVersion)

Read the CSS from the passed String using a byte stream.

Parameters:: sCSS - The source string containing the CSS to be parsed. May not be null.; aFallbackCharset - The charset to be used in case neither a @charset rule nor a BOM is present. May not be null.; eVersion - The CSS version to use. May not be null.
Returns:: null if reading failed, the CSS declarations otherwise.

readFromString

@Nullable
public static CascadingStyleSheet readFromString(@Nonnull
                                                            String sCSS,
                                                            @Nonnull
                                                            Charset aFallbackCharset,
                                                            @Nonnull
                                                            ECSSVersion eVersion,
                                                            @Nullable
                                                            ICSSParseErrorHandler aCustomErrorHandler)

Read the CSS from the passed String using a byte stream.

Parameters:: sCSS - The source string containing the CSS to be parsed. May not be null.; aFallbackCharset - The charset to be used in case neither a @charset rule nor a BOM is present. May not be null.; eVersion - The CSS version to use. May not be null.; aCustomErrorHandler - An optional custom error handler that can be used to collect the recoverable parsing errors. May be null.
Returns:: null if reading failed, the CSS declarations otherwise.

readFromString

@Nullable
public static CascadingStyleSheet readFromString(@Nonnull
                                                            String sCSS,
                                                            @Nonnull
                                                            Charset aFallbackCharset,
                                                            @Nonnull
                                                            ECSSVersion eVersion,
                                                            @Nullable
                                                            ICSSParseExceptionCallback aCustomExceptionHandler)

Read the CSS from the passed String using a byte stream.

Parameters:: sCSS - The source string containing the CSS to be parsed. May not be null.; aFallbackCharset - The charset to be used in case neither a @charset rule nor a BOM is present. May not be null.; eVersion - The CSS version to use. May not be null.; aCustomExceptionHandler - An optional custom exception handler that can be used to collect the unrecoverable parsing errors. May be null.
Returns:: null if reading failed, the CSS declarations otherwise.

readFromString

@Nullable
public static CascadingStyleSheet readFromString(@Nonnull
                                                            String sCSS,
                                                            @Nonnull
                                                            Charset aFallbackCharset,
                                                            @Nonnull
                                                            ECSSVersion eVersion,
                                                            @Nullable
                                                            ICSSParseErrorHandler aCustomErrorHandler,
                                                            @Nullable
                                                            ICSSParseExceptionCallback aCustomExceptionHandler)

Read the CSS from the passed String using a byte stream.

Parameters:: sCSS - The source string containing the CSS to be parsed. May not be null.; aFallbackCharset - The charset to be used in case neither a @charset rule nor a BOM is present. May not be null.; eVersion - The CSS version to use. May not be null.; aCustomErrorHandler - An optional custom error handler that can be used to collect the recoverable parsing errors. May be null.; aCustomExceptionHandler - An optional custom exception handler that can be used to collect the unrecoverable parsing errors. May be null.
Returns:: null if reading failed, the CSS declarations otherwise.
Since:: 3.7.3

readFromStringStream

@Nullable
public static CascadingStyleSheet readFromStringStream(@Nonnull
                                                                  String sCSS,
                                                                  @Nonnull
                                                                  CSSReaderSettings aSettings)

Read the CSS from the passed String using a byte stream.

Parameters:: sCSS - The source string containing the CSS to be parsed. May not be null.; aSettings - The settings to be used for reading the CSS. May not be null.
Returns:: null if reading failed, the CSS declarations otherwise.
Since:: 3.8.2