com.google.gwt.core.ext.soyc.impl

Class StoryImpl

java.lang.Object

com.google.gwt.core.ext.soyc.impl.StoryImpl

All Implemented Interfaces:

Story, Serializable

public class StoryImpl
extends Object
implements Story

An implementation of the Story interface. This type has two additional pieces of information not required by the Story interface. The first is a unique id number and the second is a length. Instead of storing range objects for each StoryImpl, we simply store the StoryImpls in order and calculate the Range for the StoryImpl based on its length.

See Also:

SnippetIterator#next(), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<Story>	ID_COMPARATOR Orders StoryImpl's by their id number.

Constructor Summary

Constructors

Constructor and Description
StoryImpl(int id, SortedSet<Member> members, String literalDescription, int fragment, int length) Standard constructor.
StoryImpl(StoryImpl other, int length) This is a copy-constructor that's used when we subdivide a Range.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Identity is based on the id field.
int	getFragment()
int	getId()
int	getLength() Used internally, and not specified by the Story interface.
String	getLiteralTypeName() If the Story represents a literal value, this method will return a description of the type of literal.
SortedSet<Member>	getMembers() Gets the Members of the compilation that the Story is about.
int	hashCode() Identity is based on the id field.

Methods inherited from class java.lang.Object

finalize, getClass, toString

Field Detail

ID_COMPARATOR

public static final Comparator<Story> ID_COMPARATOR

Orders StoryImpl's by their id number.

Constructor Detail

StoryImpl

public StoryImpl(int id,
                 SortedSet<Member> members,
                 String literalDescription,
                 int fragment,
                 int length)

Standard constructor. This constructor will create unmodifiable versions of the collections passed into it.

StoryImpl

public StoryImpl(StoryImpl other,
                 int length)

This is a copy-constructor that's used when we subdivide a Range. All we really care about in the shadow version is having a different length; all of the other fields are initialized from the original.

Method Detail

equals

public boolean equals(Object obj)

Identity is based on the id field.

Overrides:

equals in class Object

getFragment

public int getFragment()

getId

public int getId()

getLength

public int getLength()

Used internally, and not specified by the Story interface.

getLiteralTypeName

public String getLiteralTypeName()

Description copied from interface: Story

If the Story represents a literal value, this method will return a description of the type of literal. If the Story does not represent a literal, this method will return null.

Specified by:

getLiteralTypeName in interface Story

getMembers

public SortedSet<Member> getMembers()

Description copied from interface: Story

Gets the Members of the compilation that the Story is about.

Specified by:

getMembers in interface Story

hashCode

public int hashCode()

Identity is based on the id field.

Overrides:

hashCode in class Object