javadoc

Author: rbri

src/main/java/com/gargoylesoftware/css/dom/CSSStyleSheetListImpl.java

@@ -33,25 +33,17 @@
 public class CSSStyleSheetListImpl implements StyleSheetList {
     private List<CSSStyleSheet> cssStyleSheets_;
 
+    /**
+     * @return the list of style sheets
+     */
     public List<CSSStyleSheet> getCSSStyleSheets() {
         if (cssStyleSheets_ == null) {
             cssStyleSheets_ = new ArrayList<CSSStyleSheet>();
         }
         return cssStyleSheets_;
     }
 
-    public void setCSSStyleSheets(final List<CSSStyleSheet> cssStyleSheets) {
-        cssStyleSheets_ = cssStyleSheets;
-    }
-
-    /**
-     * Creates a new instance of CSSStyleSheetListImpl
-     */
-    public CSSStyleSheetListImpl() {
-        super();
-    }
-
-    // start StyleSheetList
+   // start StyleSheetList
     @Override
     public int getLength() {
         return getCSSStyleSheets().size();

src/main/java/com/gargoylesoftware/css/dom/CSSUnknownRuleImpl.java

@@ -35,14 +35,12 @@ public class CSSUnknownRuleImpl extends AbstractCSSRuleImpl implements CSSUnknow
 
     private String text_;
 
-    public String getText() {
-        return text_;
-    }
-
-    public void setText(final String text) {
-        text_ = text;
-    }
-
+    /**
+     * Ctor.
+     * @param parentStyleSheet the parent style sheet
+     * @param parentRule the parent rule
+     * @param text the text
+     */
     public CSSUnknownRuleImpl(
             final CSSStyleSheetImpl parentStyleSheet,
             final CSSRule parentRule,

src/main/java/com/gargoylesoftware/css/dom/CounterImpl.java

@@ -34,7 +34,10 @@ public class CounterImpl implements Counter, Serializable {
     private String separator_;
 
     /**
-     * Creates new CounterImpl
+     * Creates new CounterImpl.
+     * @param separatorSpecified true if the separator is specified
+     * @param lu the lexical unit
+     * @throws DOMException in case of error
      */
     public CounterImpl(final boolean separatorSpecified, final LexicalUnit lu) throws DOMException {
         LexicalUnit next = lu;

src/main/java/com/gargoylesoftware/css/parser/CSSException.java

@@ -19,9 +19,13 @@
  */
 public class CSSException extends RuntimeException {
 
-    public enum ErrorCode {
+    /** Enum for error codes. */
+    protected enum ErrorCode {
+        /** Unspecified. */
         UNSPECIFIED_ERR,
+        /** Not supported. */
         NOT_SUPPORTED_ERR,
+        /** Syntax error. */
         SYNTAX_ERR,
     }
 
@@ -102,7 +106,7 @@ public String getMessage() {
     }
 
     /**
-     * returns the error code for this exception.
+     * @return the error code for this exception.
      */
     public ErrorCode getCode() {
         return code_;

src/main/java/com/gargoylesoftware/css/parser/CSSOMParser.java

@@ -62,6 +62,9 @@ public CSSOMParser() {
         parser_ = new CSS3Parser();
     }
 
+    /**
+     * @param eh the error handler to be used
+     */
     public void setErrorHandler(final CSSErrorHandler eh) {
         parser_.setErrorHandler(eh);
     }
@@ -99,6 +102,13 @@ public CSSStyleDeclaration parseStyleDeclaration(final InputSource source) throw
         return sd;
     }
 
+    /**
+     * Parses a SAC input source into a CSSOM style declaration.
+     *
+     * @param source the SAC input source
+     * @param sd the CSSOM style declaration
+     * @throws IOException if the underlying SAC parser throws an IOException
+     */
     public void parseStyleDeclaration(final CSSStyleDeclaration sd, final InputSource source) throws IOException {
         final Stack<Object> nodeStack = new Stack<Object>();
         nodeStack.push(sd);
@@ -107,6 +117,13 @@ public void parseStyleDeclaration(final CSSStyleDeclaration sd, final InputSourc
         parser_.parseStyleDeclaration(source);
     }
 
+    /**
+     * Parses a SAC input source into a CSSValue.
+     *
+     * @param source the SAC input source
+     * @return the css value
+     * @throws IOException if the underlying SAC parser throws an IOException
+     */
     public CSSValue parsePropertyValue(final InputSource source) throws IOException {
         final CSSOMHandler handler = new CSSOMHandler();
         parser_.setDocumentHandler(handler);
@@ -117,19 +134,40 @@ public CSSValue parsePropertyValue(final InputSource source) throws IOException
         return new CSSValueImpl(lu);
     }
 
+    /**
+     * Parses a SAC input source into a CSSRule.
+     *
+     * @param source the SAC input source
+     * @return the css rule
+     * @throws IOException if the underlying SAC parser throws an IOException
+     */
     public CSSRule parseRule(final InputSource source) throws IOException {
         final CSSOMHandler handler = new CSSOMHandler();
         parser_.setDocumentHandler(handler);
         parser_.parseRule(source);
         return (CSSRule) handler.getRoot();
     }
 
+    /**
+     * Parses a SAC input source into a CSSSelectorList.
+     *
+     * @param source the SAC input source
+     * @return the css selector list
+     * @throws IOException if the underlying SAC parser throws an IOException
+     */
     public SelectorList parseSelectors(final InputSource source) throws IOException {
         final HandlerBase handler = new HandlerBase();
         parser_.setDocumentHandler(handler);
         return parser_.parseSelectors(source);
     }
 
+    /**
+     * Parses a SAC input source into a MediaQueryList.
+     *
+     * @param source the SAC input source
+     * @return the css media query list
+     * @throws IOException if the underlying SAC parser throws an IOException
+     */
     public MediaQueryList parseMedia(final InputSource source) throws IOException {
         final HandlerBase handler = new HandlerBase();
         parser_.setDocumentHandler(handler);
@@ -139,10 +177,16 @@ public MediaQueryList parseMedia(final InputSource source) throws IOException {
         return null;
     }
 
+    /**
+     * @param parentStyleSheet the new parent stylesheet
+     */
     public void setParentStyleSheet(final CSSStyleSheetImpl parentStyleSheet) {
         parentStyleSheet_ = parentStyleSheet;
     }
 
+    /**
+     * @return the parent style sheet
+     */
     protected CSSStyleSheetImpl getParentStyleSheet() {
         return parentStyleSheet_;
     }

src/main/java/com/gargoylesoftware/css/parser/DocumentHandler.java

@@ -33,7 +33,7 @@ public interface DocumentHandler {
      * The CSS parser will invoke this method only once, before any other
      * methods in this interface.
      *
-     * @param uri The URI of the style sheet. @@TODO can be NULL ! (inline style sheet)
+     * @param source the input source to parse
      * @exception CSSException Any CSS exception, possibly wrapping another
      *                         exception.
      */
@@ -47,7 +47,7 @@ public interface DocumentHandler {
      * method until it has either abandoned parsing (because of an
      * unrecoverable error) or reached the end of input.
      *
-     * @param uri The URI of the style sheet.
+     * @param source the input source to parse
      * @exception CSSException Any CSS exception, possibly wrapping another
      *                         exception.
      */
@@ -65,8 +65,8 @@ public interface DocumentHandler {
     /**
      * Receive notification of the end of a media statement.
      *
-     * @param media The intended destination medium for style information.
-     * @param pseudo_page the pseudo page (if any, null otherwise)
+     * @param name the name
+     * @param pseudoPage the pseudo page (if any, null otherwise)
      * @exception CSSException Any CSS exception, possibly wrapping another
      *                         exception.
      */

src/main/java/com/gargoylesoftware/css/parser/HandlerBase.java

@@ -19,6 +19,8 @@
 
 /**
  * Empty implementation of the DocumentHandlerExt interface.
+ *
+ * @author Ronald Brill
  */
 public class HandlerBase implements DocumentHandler, CSSErrorHandler {
 

src/main/java/com/gargoylesoftware/css/parser/InputSource.java

@@ -38,6 +38,7 @@ public class InputSource implements Closeable {
     /**
      * Create a new input source backed by byteStream.
      * @param byteStream the byte stream
+     * @param encoding the encoding
      * @throws UnsupportedEncodingException if the encoding is not supported
      */
     public InputSource(final InputStream byteStream, final String encoding) throws UnsupportedEncodingException {
@@ -51,13 +52,15 @@ public InputSource(final InputStream byteStream, final String encoding) throws U
 
     /**
      * Create a new input source backed by a reader.
+     * @param reader the reader
      */
     public InputSource(final Reader reader) {
         reader_ = reader;
     }
 
     /**
      * Create a new input source backed by a reader.
+     * @param uri the uri to read from
      * @throws IOException in case of error
      * @throws MalformedURLException in case of error
      */

src/main/java/com/gargoylesoftware/css/parser/Locator.java

@@ -30,7 +30,7 @@ public class Locator implements Serializable {
     private int columnNumber_;
 
     /**
-     * Creates new LocatorImpl
+     * Creates new LocatorImpl.
      * @param uri the uri
      * @param line the lineNumber
      * @param column the columnNumber

src/main/java/com/gargoylesoftware/css/parser/ParserUtils.java

@@ -41,7 +41,7 @@ public static String trimBy(final StringBuilder s, final int left, final int rig
      * Helper that removes the leading "url(", the trailing ")"
      * and surrounding quotes from the given string builder.
      * @param s the StringBuilder
-     * @return
+     * @return the trimmed string
      */
     public static String trimUrl(final StringBuilder s) {
         final String s1 = trimBy(s, 4, 1).trim();