oracle.ide.extension

Class Role

java.lang.Object

oracle.ide.extension.Role

All Implemented Interfaces:

java.lang.Comparable<Role>

public final class Role
extends java.lang.Object
implements java.lang.Comparable<Role>

Represents information about a role, which is a set of customizations of the product.

Since:

11.0

Constructor Summary

Constructors

Constructor and Description
Role(java.lang.String id, java.lang.String name, java.lang.String description) Creates an instance of a Role.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Role o)
boolean	equals(java.lang.Object o)
java.lang.String	getDescription() Returns the user visible description of this role.
java.lang.String	getId() Returns the unique identifier for this role.
java.lang.String	getName() Returns the user visible name of this role.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Role

public Role(java.lang.String id,
            java.lang.String name,
            java.lang.String description)

Creates an instance of a Role. Generally extension developers do not construct Role instances; they are constructed by the extension manager automatically from role definitions.

Parameters:

id - a unique identifier for the role. Must not be null.

name - a human readable name for the role. May be null.

description - a human readable description for the role. May be null.

Method Detail

getId

public java.lang.String getId()

Returns the unique identifier for this role.

Returns:

the unique identifier for this role. Never returns null.

getName

public java.lang.String getName()

Returns the user visible name of this role.

Returns:

the user visible name of this role. Never returns null. If no user visible name is available, returns getId().

getDescription

public java.lang.String getDescription()

Returns the user visible description of this role.

Returns:

the user visible description of this role. Never returns null, may return the empty string if no description is available.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(Role o)

Specified by:

compareTo in interface java.lang.Comparable<Role>