AbstractSyntax (Omakase CSS Parser 1.9.1-SNAPSHOT API)

java.lang.Object
- com.salesforce.omakase.ast.AbstractSyntax

All Implemented Interfaces:

Syntax, Broadcastable, Writable

Direct Known Subclasses:

AbstractAtRuleMember, AbstractGroupable, PropertyName, PropertyValue, RawFunction, RawSyntax, Stylesheet
```
public abstract class AbstractSyntax
extends Object
implements Syntax
```
Base class for Syntax units.

Constructor Summary

Constructors
Constructor and Description
`AbstractSyntax()` Creates a new instance with no line or number specified (used for dynamically created `Syntax` units).
`AbstractSyntax(int line, int column)` Creates a new instance with the given line and column numbers.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`annotate(CssAnnotation annotation)` Appends the given `CssAnnotation` to this unit.
`void`	`annotateUnlessPresent(CssAnnotation annotation)` Same as `Syntax.annotate(CssAnnotation)`, except only if `Syntax.hasAnnotation(CssAnnotation)` is false for the given annotation.
`Optional<CssAnnotation>`	`annotation(String name)` Gets the `CssAnnotation` with the given name from the comments associated with this unit, if there is one.
`List<CssAnnotation>`	`annotations()` Gets all `CssAnnotation`s from the comments associated with this unit.
`int`	`column()` The column number within the source where this `Syntax` unit was parsed.
`Syntax`	`comment(Comment comment)` Adds the given `Comment` to this unit.
`Syntax`	`comment(String comment)` Adds the given comment to this unit.
`com.google.common.collect.ImmutableList<Comment>`	`comments()` Gets all comments associated with this `Syntax` unit.
`Syntax`	`comments(Collection<String> comments)` Adds the given comments to this unit.
`Syntax`	`comments(Syntax copyFrom)` Copies all comments from the given syntax unit.
`protected <T extends Syntax> T`	`copiedFrom(T original)` This should be called on all copied units.
`abstract Syntax`	`copy()` For implementations: do not copy comments or orphaned comments, instead be sure to call `copiedFrom(Syntax)` on the new copy.
`boolean`	`equals(Object obj)`
`boolean`	`hasAnnotation(CssAnnotation annotation)` Checks if this unit has a CSS comment with a `CssAnnotation` that equals the given one.
`boolean`	`hasAnnotation(String name)` Checks if this unit has a CSS comment annotation with the given name.
`int`	`hashCode()`
`boolean`	`hasSourcePosition()` Gets whether this unit has a source location specified.
`int`	`id()` Gets the unique identifier for this unit.
`boolean`	`isWritable()` Returns whether this unit should actually be written.
`int`	`line()` The line number within the source where this `Syntax` unit was parsed.
`com.google.common.collect.ImmutableList<Comment>`	`orphanedComments()` Gets all orphaned comments (comments that appear after or at the end of the unit).
`Syntax`	`orphanedComments(Collection<String> comments)` Adds orphaned comments (comments that appears after or at the end of the unit).
`Syntax`	`orphanedComments(Syntax copyFrom)` Copies all orphaned comments from the given syntax unit.
`void`	`propagateBroadcast(Broadcaster broadcaster, Status status)` Broadcasts or rebroadcasts all child units using the given `Broadcaster`.
`boolean`	`shouldBreakBroadcast(SubscriptionPhase phase)` Gets whether an in-progress broadcast should be stopped.
`Status`	`status()` Gets the current broadcast status of this unit.
`void`	`status(Status status)` Sets the current broadcast status.
`String`	`toString()`
`String`	`toString(boolean includeUnitType)` Returns a string representation of this object.
`boolean`	`writesOwnComments()` Specifies whether this object will handle writing its own comments, instead of the automatic behavior of the `StyleWriter`.
`boolean`	`writesOwnOrphanedComments()` Specifies whether this object will handle writing its own orphaned comments, instead of the automatic behavior of the `StyleWriter`.

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

Methods inherited from interface com.salesforce.omakase.writer.Writable
write

- Constructor Detail
  - AbstractSyntax
```
public AbstractSyntax()
```
    Creates a new instance with no line or number specified (used for dynamically created Syntax units).
  - AbstractSyntax
```
public AbstractSyntax(int line,
                      int column)
```
    Creates a new instance with the given line and column numbers.
    
    Parameters:
    
    line - The line number.
    
    column - The column number.
- Method Detail
  - id
```
public int id()
```
    Description copied from interface: Syntax
    
    Gets the unique identifier for this unit. This can be used as a key in maps or in any other case where storing a short identifier is preferable.
    
    Specified by:
    
    id in interface Syntax
    
    Returns:
    
    The unique identifier.
  - line
```
public int line()
```
    Description copied from interface: Syntax
    
    The line number within the source where this Syntax unit was parsed.
    
    Specified by:
    
    line in interface Syntax
    
    Returns:
    
    The line number.
  - column
```
public int column()
```
    Description copied from interface: Syntax
    
    The column number within the source where this Syntax unit was parsed.
    
    Specified by:
    
    column in interface Syntax
    
    Returns:
    
    The column number.
  - hasSourcePosition
```
public boolean hasSourcePosition()
```
    Description copied from interface: Syntax
    
    Gets whether this unit has a source location specified.
    This will be true for units within the original parsed source and false for dynamically created units.
    
    Specified by:
    
    hasSourcePosition in interface Syntax
    
    Returns:
    
    True if this unit has a source location specified.
  - copy
```
public abstract Syntax copy()
```
    For implementations: do not copy comments or orphaned comments, instead be sure to call copiedFrom(Syntax) on the new copy.
    
    Specified by:
    
    copy in interface Syntax
    
    Returns:
    
    The new instance.
  - copiedFrom
```
protected final <T extends Syntax> T copiedFrom(T original)
```
    This should be called on all copied units. It handles shared logic such as copying comments.
    Examples:
```
     Rule copy = new Rule().copiedFrom(original);
 
```
    Type Parameters:
    
    T - Syntax type.
    
    Parameters:
    
    original - The original, copied unit.
    
    Returns:
    
    this, for chaining.
  - comment
```
public Syntax comment(String comment)
```
    Description copied from interface: Syntax
    
    Adds the given comment to this unit.
    Note that in the case of Selectors, it is preferred to add comments to the Selector object itself instead of the individual SimpleSelectors inside of it. Likewise, it is preferred to add a comment to the Declaration itself instead of the property name or value inside of it.
    
    Specified by:
    
    comment in interface Syntax
    
    Parameters:
    
    comment - The comment to add.
    
    Returns:
    
    this, for chaining.
  - comment
```
public Syntax comment(Comment comment)
```
    Description copied from interface: Syntax
    
    Adds the given Comment to this unit.
    Note that in the case of Selectors, it is preferred to add comments to the Selector object itself instead of the individual SimpleSelectors inside of it. Likewise, it is preferred to add a comment to the Declaration itself instead of the property name or value inside of it.
    
    Specified by:
    
    comment in interface Syntax
    
    Parameters:
    
    comment - The comment to add.
    
    Returns:
    
    this, for chaining.
  - comments
```
public Syntax comments(Collection<String> comments)
```
    Description copied from interface: Syntax
    
    Adds the given comments to this unit.
    Note that in the case of Selectors, it is preferred to add comments to the Selector object itself instead of the individual SimpleSelectors inside of it. Likewise, it is preferred to add a comment to the Declaration itself instead of the property name or value inside of it.
    
    Specified by:
    
    comments in interface Syntax
    
    Parameters:
    
    comments - The comments to add.
    
    Returns:
    
    this, for chaining.
  - comments
```
public Syntax comments(Syntax copyFrom)
```
    Description copied from interface: Syntax
    
    Copies all comments from the given syntax unit.
    
    Specified by:
    
    comments in interface Syntax
    
    Parameters:
    
    copyFrom - Copy comments from this unit.
    
    Returns:
    
    this, for chaining.
  - comments
```
public com.google.common.collect.ImmutableList<Comment> comments()
```
    Description copied from interface: Syntax
    
    Gets all comments associated with this Syntax unit.
    A unit is associated with all comments that directly precede it. However in the case of comments at the start of a Rule, the first Selector will contain the comment, not the Rule or the SimpleSelector. For more info, see the main readme file.
    
    Specified by:
    
    comments in interface Syntax
    
    Returns:
    
    The list of comments. Never returns null.
  - orphanedComments
```
public Syntax orphanedComments(Collection<String> comments)
```
    Description copied from interface: Syntax
    
    Adds orphaned comments (comments that appears after or at the end of the unit).
    
    Specified by:
    
    orphanedComments in interface Syntax
    
    Parameters:
    
    comments - The comments to add.
    
    Returns:
    
    this, for chaining.
  - orphanedComments
```
public Syntax orphanedComments(Syntax copyFrom)
```
    Description copied from interface: Syntax
    
    Copies all orphaned comments from the given syntax unit.
    
    Specified by:
    
    orphanedComments in interface Syntax
    
    Parameters:
    
    copyFrom - Copy orphaned comments from this unit.
    
    Returns:
    
    this, for chaining.
  - orphanedComments
```
public com.google.common.collect.ImmutableList<Comment> orphanedComments()
```
    Description copied from interface: Syntax
    
    Gets all orphaned comments (comments that appear after or at the end of the unit).
    A comment is considered orphaned if it does not appear before a logically associated unit. For example, comments at the end of a stylesheet or declaration block.
    
    Specified by:
    
    orphanedComments in interface Syntax
    
    Returns:
    
    The list of comments. Never returns null.
  - hasAnnotation
```
public boolean hasAnnotation(String name)
```
    Description copied from interface: Syntax
    
    Checks if this unit has a CSS comment annotation with the given name.
    CSS comment annotations are CSS comments that contain an annotation in the format of "@annotationName [optionalArgs]", for example "@noparse", "@browser ie7", etc...
    Only one annotation per comment block is allowed.
    A unit is associated with all comments that directly precede it. However in the case of comments at the start of a Rule, the first Selector will contain the comment, not the Rule or the SimpleSelector. For convenience, the Rule will check the comments on the first Selector for annotation getter methods (which includes this method). For more info, see the main readme file.
    
    Specified by:
    
    hasAnnotation in interface Syntax
    
    Parameters:
    
    name - Check for an annotation with this name.
    
    Returns:
    
    True if a CssAnnotation was found with the given name in Comments associated with this unit.
  - hasAnnotation
```
public boolean hasAnnotation(CssAnnotation annotation)
```
    Description copied from interface: Syntax
    
    Checks if this unit has a CSS comment with a CssAnnotation that equals the given one.
    A unit is associated with all comments that directly precede it. However in the case of comments at the start of a Rule, the first Selector will contain the comment, not the Rule or the SimpleSelector. For convenience, the Rule will check the comments on the first Selector for annotation getter methods though, including this method. For more info, see the main readme file.
    This is most useful in tangent with the Syntax.annotate(CssAnnotation) method. You can annotate many syntax units using that method and then subsequently check for the annotation using this method, reusing the same instance in all cases for efficiency.
    The annotation must match according to the rules defined in CssAnnotation.equals(Object).
    A unit is associated with all comments that directly precede it. However in the case of comments at the start of a Rule, the first Selector will contain the comment, not the Rule or the SimpleSelector. For convenience, the Rule will check the comments on the first Selector for annotation getter methods (which includes this method). For more info, see the main readme file.
    
    Specified by:
    
    hasAnnotation in interface Syntax
    
    Parameters:
    
    annotation - Check for a CssAnnotation that equals this one.
    
    Returns:
    
    True if a CssAnnotation was found that equals the given one.
  - annotation
```
public Optional<CssAnnotation> annotation(String name)
```
    Description copied from interface: Syntax
    
    Gets the CssAnnotation with the given name from the comments associated with this unit, if there is one.
    CSS comment annotations are CSS comments that contain an annotation in the format of "@annotationName [optionalArgs]", for example "@noparse", "@browser ie7", etc...
    Only one annotation per comment block is allowed.
    A unit is associated with all comments that directly precede it. However in the case of comments at the start of a Rule, the first Selector will contain the comment, not the Rule or the SimpleSelector. For convenience, the Rule will check the comments on the first Selector for annotation getter methods (which includes this method). For more info, see the main readme file.
    
    Specified by:
    
    annotation in interface Syntax
    
    Parameters:
    
    name - Get the annotation with this name.
    
    Returns:
    
    The CssAnnotation, or an empty Optional if not found.
  - annotations
```
public List<CssAnnotation> annotations()
```
    Description copied from interface: Syntax
    
    Gets all CssAnnotations from the comments associated with this unit.
    CSS comment annotations are CSS comments that contain an annotation in the format of "@annotationName [optionalArgs]", for example "@noparse", "@browser ie7", etc...
    Only one annotation per comment block is allowed.
    A unit is associated with all comments that directly precede it. However in the case of comments at the start of a Rule, the first Selector will contain the comment, not the Rule or the SimpleSelector. For convenience, the Rule will check the comments on the first Selector for annotation getter methods (which includes this method). For more info, see the main readme file.
    
    Specified by:
    
    annotations in interface Syntax
    
    Returns:
    
    All found CssAnnotations.
  - annotate
```
public void annotate(CssAnnotation annotation)
```
    Description copied from interface: Syntax
    
    Appends the given CssAnnotation to this unit.
    A Comment will be created and appended to this unit using the normal CSS comment annotation syntax. This means if CSS comments are written out then they will include this annotation. The comment will also be returned by normal comment retrieval methods such as Syntax.comments().
    You can subsequently check for this annotation again using the Syntax.hasAnnotation(CssAnnotation) method. This might be useful in plugins that dynamically annotate syntax units and then subsequently check for the annotation later on, as using both of these methods can efficiently reuse the same CssAnnotation instance.
    
    Specified by:
    
    annotate in interface Syntax
    
    Parameters:
    
    annotation - Append this annotation.
  - annotateUnlessPresent
```
public void annotateUnlessPresent(CssAnnotation annotation)
```
    Description copied from interface: Syntax
    
    Same as Syntax.annotate(CssAnnotation), except only if Syntax.hasAnnotation(CssAnnotation) is false for the given annotation.
    Note that if using this method on a Rule that comments at the start of a Rule are usually associated with the Selector, and this method will not check the Selector when determining if the annotation is present. Thus you should only call this method on a Rule if you are sure the annotation was manually added to the Rule.
    
    Specified by:
    
    annotateUnlessPresent in interface Syntax
    
    Parameters:
    
    annotation - Add this annotation.
  - status
```
public void status(Status status)
```
    Description copied from interface: Broadcastable
    
    Sets the current broadcast status. Normally for internal use. Do not call without understanding the implications.
    
    Specified by:
    
    status in interface Broadcastable
    
    Parameters:
    
    status - The new status.
  - status
```
public Status status()
```
    Description copied from interface: Broadcastable
    
    Gets the current broadcast status of this unit.
    This primarily determines whether this unit should be broadcasted again.
    
    Specified by:
    
    status in interface Broadcastable
    
    Returns:
    
    The current broadcast status.
  - propagateBroadcast
```
public void propagateBroadcast(Broadcaster broadcaster,
                               Status status)
```
    Description copied from interface: Broadcastable
    
    Broadcasts or rebroadcasts all child units using the given Broadcaster.
    The broadcast will only occur for a unit if its Status matches the given Status.
    Implementers should call this on child units and SyntaxCollections first, then use the broadcaster to broadcast itself. All of this should be wrapped in a check to ensure the Status matches.
    
    Specified by:
    
    propagateBroadcast in interface Broadcastable
    
    Parameters:
    
    broadcaster - Use this Broadcaster to broadcast all unbroadcasted child units.
    
    status - Broadcast units that have this status.
  - shouldBreakBroadcast
```
public boolean shouldBreakBroadcast(SubscriptionPhase phase)
```
    Description copied from interface: Broadcastable
    
    Gets whether an in-progress broadcast should be stopped.
    This might be true if a change of state or conditions of the unit result in the broadcast no longer being necessary during the given SubscriptionPhase.
    
    Specified by:
    
    shouldBreakBroadcast in interface Broadcastable
    
    Parameters:
    
    phase - The current SubscriptionPhase.
    
    Returns:
    
    True if in-progress broadcasting should be stopped.
  - isWritable
```
public boolean isWritable()
```
    Description copied from interface: Writable
    
    Returns whether this unit should actually be written.
    Usually this should just return true, however some units that are detachable or otherwise potentially invalid should first check their state and respond appropriately.
    
    Specified by:
    
    isWritable in interface Writable
    
    Returns:
    
    True if the unit should be written.
  - writesOwnComments
```
public boolean writesOwnComments()
```
    Description copied from interface: Syntax
    
    Specifies whether this object will handle writing its own comments, instead of the automatic behavior of the StyleWriter.
    If returning true, be sure to check StyleWriter#shouldWriteAllComments() to determine if comments should actually be written out or not. The StyleWriter#appendComments(Iterable, StyleAppendable) utility method contains this logic and is the preferable way to handle it.
    
    Specified by:
    
    writesOwnComments in interface Syntax
    
    Returns:
    
    True if this object writes its own comments.
  - writesOwnOrphanedComments
```
public boolean writesOwnOrphanedComments()
```
    Description copied from interface: Syntax
    
    Specifies whether this object will handle writing its own orphaned comments, instead of the automatic behavior of the StyleWriter.
    If returning true, be sure to check StyleWriter#shouldWriteAllComments() to determine if comments should actually be written out or not. The StyleWriter#appendComments(Iterable, StyleAppendable) utility method contains this logic and is the preferable way to handle it.
    
    Specified by:
    
    writesOwnOrphanedComments in interface Syntax
    
    Returns:
    
    True if this object writes its own comments.
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object
  - toString
```
public final String toString(boolean includeUnitType)
```
    Description copied from interface: Syntax
    
    Returns a string representation of this object.
    
    Specified by:
    
    toString in interface Syntax
    
    Parameters:
    
    includeUnitType - Specify true to append in parenthesis the syntax type (e.g., 'pseudo-element-selector').
    
    Returns:
    
    The string.

Class AbstractSyntax

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.salesforce.omakase.writer.Writable

Constructor Detail

AbstractSyntax

AbstractSyntax

Method Detail

id

line

column

hasSourcePosition

copy

copiedFrom

comment

comment

comments

comments

comments

orphanedComments

orphanedComments

orphanedComments

hasAnnotation

hasAnnotation

annotation

annotations

annotate

annotateUnlessPresent

status

status

propagateBroadcast

shouldBreakBroadcast

isWritable

writesOwnComments

writesOwnOrphanedComments

hashCode

equals

toString

toString