com.starbase.starteam
Class NoKeywords

java.lang.Object
  |
  +--com.starbase.starteam.SimpleKeyword
        |
        +--com.starbase.starteam.NoKeywords

All Implemented Interfaces:

Keyword

public class NoKeywords

extends SimpleKeyword

A special Keyword implementation that halts keyword expansion for the rest of a file when encountered. The keyword is $NoKeywords$

Constructor Summary

NoKeywords()
Creates a instance of this class.

Method Summary

boolean	equals(java.lang.Object source) returns true if this object instance is equal to the source
java.lang.String	expand(java.lang.String linePrefix, java.lang.String eol, boolean expand) Always returns "NoKeywords$"
int	hashCode() returns a unique hash for all instances of this type
boolean	stopExpanding() Always returns true.

Methods inherited from class com.starbase.starteam.SimpleKeyword

getName, getValue, matches, multiLine, toXMLString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NoKeywords

public NoKeywords()

Creates a instance of this class.

Method Detail

stopExpanding

public boolean stopExpanding()

Always returns true. This causes keyword expansion to halt once this keyword is encountered in a file.

Specified by:

stopExpanding in interface Keyword

Overrides:

stopExpanding in class SimpleKeyword

Returns:

true always

expand

public java.lang.String expand(java.lang.String linePrefix,
                               java.lang.String eol,
                               boolean expand)

Always returns "NoKeywords$"

Specified by:

expand in interface Keyword

Overrides:

expand in class SimpleKeyword

Parameters:

linePrefix - the begining of the line in the souce leading up to the keyword

eol - the end-of-line convention used in the source file

expand - true if the keyword is to be expanded and false for unexpand

Returns:

always returns "NoKeywords$"

equals

public boolean equals(java.lang.Object source)

returns true if this object instance is equal to the source

Overrides:

equals in class SimpleKeyword

Parameters:

source - Object the source to comapre with

Returns:

boolean true if this object is equal to the source

hashCode

public int hashCode()

returns a unique hash for all instances of this type

Overrides:

hashCode in class SimpleKeyword

Returns:

int a unique hash for all instances of this type