Package Torello.CSS

Class Punct

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.CharSequence, java.lang.Comparable<java.lang.CharSequence>
    public final class Punct
extends CSSToken
implements java.lang.CharSequence, java.io.Serializable, java.lang.Comparable<java.lang.CharSequence>
    This is a Token Data-Class. It is a descendant of the root CSSToken-Class: CSSToken. Instances of the class are usually are produced by the CSSTokenizer class. Many (but not all) of these subclasses maintain a static-method for building instances of this class named 'build'. Any CSSToken-subclass that is neither a singleton-instance, nor an "Error-Subtype" should have such a builder. Singeton instances do not need builders, and the two Error-Subtype Classes can only be generated by the tokenizer.

    All CSSToken subclasses have a CSSToken.str field which contains the exact character data that was extracted and used to construct instances of this class. All sub-casses also have several "Loop Optimization" methods. These are methods that may or may not be useful in light of some of the newer additions to JDK 17 & 21 including the 'instanceof varName' conditional-expression variable-naming features.

    The algorithms used to write this tokenizer were generated based solely on the CSS Working-Group's Syntax-Documentation. This document may be viewed here: CSS Working-Group CSS-Syntax. There is an external site that maintain all thing CSS located at drafts.csswg.org
    A class for saving one of nine different Punctuation-Token classes. The nine-available singleton-instances include: ':', ';', ',', '[', ']', '(', ')', '{', '}'
    See Also:
    Serialized Form


    • Field Detail

      • serialVersionUID

        🡇  ⇈  ⮫ 🗕  🗗  🗖 
        protected static final long serialVersionUID
        This fulfils the SerialVersion UID requirement for all classes that implement Java's interface java.io.Serializable. Using the Serializable Implementation offered by java is very easy, and can make saving program state when debugging a lot easier. It can also be used in place of more complicated systems like "hibernate" to store data as well.
        See Also:
        Constant Field Values
        Code:
        Exact Field Declaration Expression:
         protected static final long serialVersionUID = 1;

      • c

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public final char c
        The actual character that comprises this Punxtuation-Mark Token. Because Class Punct only allows singleton instances, therefore there is a limited number of characters to which this field may be assigned.

        The nine singleton instances of Class Punct are built for the following nine punctuation characters: ':' ';' ',' '[' ']' '(' ')' '{' '}'

    • Method Detail

      • isPunct

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public final boolean isPunct()
        Description copied from class: CSSToken
        Loop Optimization: This method only returns TRUE if this is an actual instance of Punct.
        Overrides:
        isPunct in class CSSToken
        Returns:
        This method returns FALSE for all instances of CSSToken, except when 'this' instance is actually the Punct Subclass.

        That class has overridden this method, and returns TRUE.
        See Also:
        isPunct()

      • ifPunct

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public final Punct ifPunct()
        Description copied from class: CSSToken
        Loop Optimization: When this method is invoked on an instance of sub-class Punct this method produces 'this' instance.
        Overrides:
        ifPunct in class CSSToken
        Returns:
        This method shall return null, always, except when 'this' is an actual instance of Punct. When so, this method simply returns 'this'. All other sub-classes of (abstract) class CSSToken inherit this method, and therefore return null.
        See Also:
        ifPunct()

      • get

        🡅  ⇈  ⮫ 🗕  🗗  🗖 
        public static final Punct get​(char c)
        Retrieve the singleton instance of a particular CSS Character.
        Parameters:
        c - Any Java 'char' primitive, but only the following characters will generate a non-null result from this method: ':', ';', ',', '[', ']', '(', ')', '{', '}' .
        Returns:
        The singleton instance of Punct corresponding to 'c'. If 'c' doesn't have any corresponding Punct Singleton-Instance, then null is returned.