Package com.pnfsoftware.jeb.core.units.impl

Class MetaComment

java.lang.Object

com.pnfsoftware.jeb.core.units.impl.MetaComment

@Ser
public class MetaComment
extends Object

A meta comment, used to add information to a full comment. Immutable. Flags are optional and specific to the managing AbstractCommentManager.

Constructor Summary

Constructors

Constructor	Description
MetaComment(MetaComment mc)	Copy a meta-comment.
MetaComment(String value)	Create a meta-comment without flags.
MetaComment(String value, int flags)	Create a meta-comment.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static String	formatFlags(int f)	Format comment flags.
int	getFlags()	Retrieve the comment flags.
String	getValue()	Retrieve the comment value.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

MetaComment

public MetaComment(String value,
 int flags)

Create a meta-comment.

Parameters:

value - comment value

flags - comment flags

MetaComment

public MetaComment(MetaComment mc)

Copy a meta-comment.

Parameters:

mc - source meta-comment

MetaComment

public MetaComment(String value)

Create a meta-comment without flags.

Parameters:

value - comment value

Method Details

getValue

public String getValue()

Retrieve the comment value.

Returns:

comment value

getFlags

public int getFlags()

Retrieve the comment flags.

Returns:

comment flags

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

formatFlags

public static String formatFlags(int f)

Format comment flags.

Parameters:

f - flags

Returns:

formatted flags