Package ghidra.program.model.listing

Enum Class CommentType

java.lang.Object

java.lang.Enum<CommentType>

ghidra.program.model.listing.CommentType

All Implemented Interfaces:

Serializable, Comparable<CommentType>, Constable

public enum CommentType
extends Enum<CommentType>

Types of comments that be placed at an address or on a CodeUnit

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EOL
PLATE
POST
PRE
REPEATABLE

Method Summary

Modifier and Type	Method	Description
static CommentType	valueOf(int commentType)	Get the comment type which corresponds to the specified ordinal value.
static CommentType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CommentType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EOL

public static final CommentType EOL

PRE

public static final CommentType PRE

POST

public static final CommentType POST

PLATE

public static final CommentType PLATE

REPEATABLE

public static final CommentType REPEATABLE

Method Details

values

public static CommentType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CommentType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

valueOf

public static CommentType valueOf(int commentType)
                           throws IllegalArgumentException

Get the comment type which corresponds to the specified ordinal value.

NOTE: This method is intended for conversion of old legacy commentType integer values to the enum type.

Parameters:

commentType - comment type value

Returns:

comment type enum which corresponds to specified ordinal

Throws:

IllegalArgumentException - if invalid comment type ordinal specified