javax.management.relation

接口
异常
java.lang.Object
  继承者 javax.management.relation.RoleInfo
所有已实现的接口:
Serializable

public class RoleInfo
     
extends Object
implements Serializable

RoleInfo 概括介绍关系类型中的角色。

此类的 serialVersionUID2504952983494636987L

从以下版本开始:
1.5
另请参见:
序列化表格

字段摘要
static int ROLE_CARDINALITY_INFINITY
          指定无限的容量。
 
构造方法摘要
RoleInfo(RoleInfo roleInfo)
          复制构造方法。
RoleInfo(String roleName, String mbeanClassName)
          构造方法。
RoleInfo(String roleName, String mbeanClassName, boolean read, boolean write)
          构造方法。
RoleInfo(String roleName, String mbeanClassName, boolean read, boolean write, int min, int max, String descr)
          构造方法。
 
方法摘要
 boolean checkMaxDegree(int value)
          如果 value 参数小于或等于期望的最大程度,则返回 true;否则返回 false。
 boolean checkMinDegree(int value)
          如果 value 参数大于或等于期望的最小程度,则返回 true;否则返回 false。
 String getDescription()
          返回角色的描述文本。
 int getMaxDegree()
          返回相应角色引用的最大程度。
 int getMinDegree()
          返回相应角色引用的最小程度。
 String getName()
          返回角色名称。
 String getRefMBeanClassName()
          返回期望在相应角色中引用的 MBean 的类型名称。
 boolean isReadable()
          返回角色的读取访问模式(如果可读,则返回 true)。
 boolean isWritable()
          返回角色的写入访问模式(如果可写,则返回 true)。
 String toString()
          返回描述角色信息的字符串。
 
从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

字段详细信息

ROLE_CARDINALITY_INFINITY

public static final int ROLE_CARDINALITY_INFINITY
指定无限的容量。

另请参见:
常量字段值
构造方法详细信息

RoleInfo

public RoleInfo(String roleName,
                String mbeanClassName,
                boolean read,
                boolean write,
                int min,
                int max,
                String descr)
         throws IllegalArgumentException,
                InvalidRoleInfoException,
                ClassNotFoundException,
                NotCompliantMBeanException
构造方法。

参数:
roleName - 角色的名称。
mbeanClassName - 期望在相应角色中引用的 MBean 的类名称。如果 MBean M 在此角色中,则对于 isInstanceOf(M, mbeanClassName),MBean 服务器必须返回 true。
read - 指示相应角色是否可读的标志
write - 指示相应角色是否可设置的标志
min - 角色的最小程度,即要在相应角色提供的 MBean 的最小数必须小于或等于 max。(ROLE_CARDINALITY_INFINITY 不受限制)
max - 角色的最大程度,即要在相应角色中提供的 MBean 的最大数必须大于或等于 min(ROLE_CARDINALITY_INFINITY 不受限制)
descr - 角色的描述(可以为 null)
抛出:
IllegalArgumentException - 如果参数为 null
InvalidRoleInfoException - 如果最小程度大于最大程度。
ClassNotFoundException - 从 JMX 1.2 开始,不再抛出此异常。它将保留在此类的声明中,以便与现有代码兼容。
NotCompliantMBeanException - 如果类 mbeanClassName 不是 MBean 类。

RoleInfo

public RoleInfo(String roleName,
                String mbeanClassName,
                boolean read,
                boolean write)
         throws IllegalArgumentException,
                ClassNotFoundException,
                NotCompliantMBeanException
构造方法。

参数:
roleName - 角色的名称
mbeanClassName - 期望在相应角色中引用的 MBean 的类名称。如果 MBean M 在此角色中,则对于 isInstanceOf(M, mbeanClassName),MBean 服务器必须返回 true。
read - 指示相应角色是否可读的标志
write - 指示相应角色是否可设置的标志

默认为 1 的最小和最大程度。

默认为 null 的角色描述。

抛出:
IllegalArgumentException - 如果参数为 null
ClassNotFoundException - 从 JMX 1.2 开始,不再抛出此异常。它将保留在此类的声明中,以便与现有代码兼容。
NotCompliantMBeanException - 从 JMX 1.2 开始,不再抛出此异常。它将保留在此类的声明中,以便与现有代码兼容。

RoleInfo

public RoleInfo(String roleName,
                String mbeanClassName)
         throws IllegalArgumentException,
                ClassNotFoundException,
                NotCompliantMBeanException
构造方法。

参数:
roleName - 角色的名称
mbeanClassName - 期望在相应角色中引用的 MBean 的类名称。如果 MBean M 在此角色中,则对于 isInstanceOf(M, mbeanClassName),MBean 服务器必须返回 true。

默认为 true 的 IsReadable 和 IsWritable。

默认为 1 的最小和最大程度。

默认为 null 的角色描述。

抛出:
IllegalArgumentException - 如果参数为 null
ClassNotFoundException - 从 JMX 1.2 开始,不再抛出此异常。它将保留在此类的声明中,以便与现有代码兼容。
NotCompliantMBeanException - 从 JMX 1.2 开始,不再抛出此异常。它将保留在此类的声明中,以便与现有代码兼容。

RoleInfo

public RoleInfo(RoleInfo roleInfo)
         throws IllegalArgumentException
复制构造方法。

参数:
roleInfo - 要复制的 RoleInfo 实例。
抛出:
IllegalArgumentException - 如果参数为 null
方法详细信息

getName

public String getName()
返回角色名称。

返回:
角色名称。

isReadable

public boolean isReadable()
返回角色的读取访问模式(如果可读,则返回 true)。

返回:
如果角色可读,则返回 true

isWritable

public boolean isWritable()
返回角色的写入访问模式(如果可写,则返回 true)。

返回:
如果角色可写,则返回 true。

getDescription

public String getDescription()
返回角色的描述文本。

返回:
角色的描述。

getMinDegree

public int getMinDegree()
返回相应角色引用的最小程度。

返回:
最小程度。

getMaxDegree

public int getMaxDegree()
返回相应角色引用的最大程度。

返回:
最大程度。

getRefMBeanClassName

public String getRefMBeanClassName()

返回期望在相应角色中引用的 MBean 的类型名称。

返回:
引用的类型名称。

checkMinDegree

public boolean checkMinDegree(int value)
如果 value 参数大于或等于期望的最小程度,则返回 true;否则返回 false。

参数:
value - 要检查的值
返回:
如果大于或等于最小程度,则返回 true;否则返回 false。

checkMaxDegree

public boolean checkMaxDegree(int value)
如果 value 参数小于或等于期望的最大程度,则返回 true;否则返回 false。

参数:
value - 要检查的值
返回:
如果小于或等于最大程度,则返回 true;否则返回 false。

toString

public String toString()
返回描述角色信息的字符串。

覆盖:
Object 中的 toString
返回:
角色信息的描述。