com.bmc.arsys.plugins.ftsconfig.helper.shared

Class CommentEntry

java.lang.Object

com.bmc.arsys.plugins.ftsconfig.helper.shared.AbstractEntry

com.bmc.arsys.plugins.ftsconfig.helper.shared.CommentEntry

public class CommentEntry
extends AbstractEntry

CommentEntry represents a comment entry in a configuration file

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE Field TYPE (1)

Constructor Summary

Constructors

Constructor and Description
CommentEntry(String startToken, String body) Constructor for single line CommentEntry
CommentEntry(String startToken, String body, String stopToken) Constructor for multiple line CommentEntry

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Determines if another Object is equal to this one
String	getBody() Gets the comment body
String	getStartToken() Gets the start token for comment
String	getStopToken() Gets the stop token for comment
int	getType() Gets the entry type
int	hashCode() Gets the hash code for this Object
boolean	isMultiline() Gets whether this is a single line or a multiple line comment
void	setBody(String body) Sets the comment body
String	toString() Gets a String representation of this Object

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final int TYPE

Field TYPE (1)

See Also:

Constant Field Values

Constructor Detail

CommentEntry

public CommentEntry(String startToken,
            String body)

Constructor for single line CommentEntry

Parameters:

startToken - start token for comment

body - comment body

CommentEntry

public CommentEntry(String startToken,
            String body,
            String stopToken)

Constructor for multiple line CommentEntry

Parameters:

startToken - start token for comment

body - comment body

stopToken - stop token for comment

Method Detail

getType

public int getType()

Gets the entry type

Specified by:

getType in class AbstractEntry

Returns:

entry type

getStartToken

public String getStartToken()

Gets the start token for comment

Returns:

start token for comment

getBody

public String getBody()

Gets the comment body

Returns:

comment body

setBody

public void setBody(String body)

Sets the comment body

Parameters:

body - comment body

getStopToken

public String getStopToken()

Gets the stop token for comment

Returns:

stop token for comment

isMultiline

public boolean isMultiline()

Gets whether this is a single line or a multiple line comment

Returns:

true if this is a multiple line comment, false otherwise

equals

public boolean equals(Object obj)

Determines if another Object is equal to this one

Overrides:

equals in class Object

Parameters:

obj - Object to test for equality

Returns:

true if Objects are equal, false otherwise

hashCode

public int hashCode()

Gets the hash code for this Object

Overrides:

hashCode in class Object

Returns:

hash code for this Object

toString

public String toString()

Gets a String representation of this Object

Overrides:

toString in class Object

Returns:

String representation of this Object