javax.management
인터페이스 Descriptor

모든 슈퍼 인터페이스:

Cloneable, Serializable

알려진 구현 클래스 목록:

DescriptorSupport

public interface Descriptor
extends Serializable,
 Cloneable 

이 인터페이스는 JMX 요소의 동작의 메타데이타셋트를 나타냅니다. 예를 들어기술자는 ModelMBeanInfo, ModelMBeanNotificationInfo, ModelMBeanAttributeInfo, ModelMBeanConstructorInfo 및 ModelMBeanParameterInfo 일부가 됩니다.

기술자는 복수의 필드로부터 완성됩니다. 각 필드는 fieldname=fieldvalue 형식이 되어 있습니다.

모든 필드의 이름과 값은 미정도리입니다. 임의의 프로그램으로 새로운 필드를 정의해, 추가할 수 있습니다 . ModelMBean 에는 구현의 정합성을 확보해, ModelMBeanInfo, ModelMBean*Info 및 ModelMBean 클래스에 한 지원를 얻기 위해, 미리 정의 끝난 필드가 있습니다.

도입된 버전 :

1.5

메서드 개요

Object	clone () 새로운 Descriptor (Descriptor 복제)를 리턴합니다.
String []	getFieldNames () 기술자내의 모든 필드명을 리턴합니다.
String []	getFields () 이 기술자에게 포함되는 모든 필드를 단일의 배열로서 리턴합니다.
Object	getFieldValue (String fieldName) 특정의 필드명을 나타내는 값을 리턴합니다.
Object []	getFieldValues (String [] fieldNames) 기술자내의 모든 필드의 값을 Object 배열로서 리턴합니다.
boolean	isValid () 모든 필드의 유효한 값에 이름이 부여되고 있는 경우, true를 리턴합니다.
void	removeField (String fieldName) 기술자로부터 필드를 삭제합니다.
void	setField (String fieldName, Object fieldValue) 특정의 필드명을 나타내는 값을 설정합니다.
void	setFields (String [] fieldNames, Object [] fieldValues) 리스트내의 모든 필드에 새로운 값 (fieldValue 배열내의 인덱스와 같은 값)을 설정합니다.

메서드의 상세

getFieldValue

Object  getFieldValue(String  fieldName)
                     throws RuntimeOperationsException 

특정의 필드명을 나타내는 값을 리턴합니다.

파라미터:

fieldName - 필드명. 발견되지 않는 경우는 null

반환값:

객체 필드값

예외:

RuntimeOperationsException - 필드명의 값이 부정한 경우

setField

void setField(String  fieldName,
              Object  fieldValue)
              throws RuntimeOperationsException 

특정의 필드명을 나타내는 값을 설정합니다. 필드명의 설정전에 타당성의 체크를의해 유효하지 않은 경우는 예외가 발생 됩니다. 이 조작에의해 기존의 필드가 변경되거나 새로운 필드가 추가 되거나 합니다.

파라미터:

fieldName - 설정되는 필드명. null 나 공문자열은 사용할 수 없는

fieldValue - 필드명으로서 설정되는 값. null도 가능

예외:

RuntimeOperationsException - 필드명 또는 필드값을 나타내는 값이 부정한 경우

getFields

String [] getFields()

이 기술자에게 포함되는 모든 필드를 단일의 배열로서 리턴합니다.

반환값:

필드의 문자 배열. 형식은 fieldName=fieldValue. 필드의 값이 String가 아닌 경우, toString() 메서드가 불려 간다. 반환값은 리턴된 배열내의 필드의 값으로 해서 사용된다. String가 아닌 객체치는 괄호로 둘러싸인 형식에서 나타내진다. 기술자가 비어있는 경우, 비어있는 배열이 리턴된

관련 항목:

setFields(java.lang.String[], java.lang.Object[])

getFieldNames

String [] getFieldNames()

기술자내의 모든 필드명을 리턴합니다.

반환값:

필드명으로부터 완성되는 문자 배열. 기술자가 비어있는 경우, 비어있는 배열이 리턴된다

getFieldValues

Object [] getFieldValues(String [] fieldNames)

기술자내의 모든 필드의 값을 Object 배열로서 리턴합니다. 리턴된 값의 차례는 fieldNames String 배열 파라미터의 경우와 같게 됩니다.

파라미터:

fieldNames - 값이 리턴된 필드의 이름에서 완성되는 문자 배열. 배열이 비어있는 경우, 비어있는 배열이 리턴된다. 배열이 null인 경우, 모든 값이 리턴된다. 배열내의 필드명이 존재하지 않는 경우, 대응하는 배열 요소의 위치에 null이 리턴된다

반환값:

필드값로부터 완성되는 객체 배열. 기술자가 비어있는 경우, 비어있는 배열이 리턴된다

removeField

void removeField(String  fieldName)

기술자로부터 필드를 삭제합니다.

파라미터:

fieldName - 삭제되는 필드의 캐릭터 라인명. 필드가 발견되지 않는 경우, 예외는 Throw 되지 않는다

setFields

void setFields(String [] fieldNames,
               Object [] fieldValues)
               throws RuntimeOperationsException 

리스트내의 모든 필드에 새로운 값 (fieldValue 배열내의 인덱스와 같은 값)을 설정합니다. 배열 사이즈는 일치하고 있을 필요가 있습니다. 필드값의 설정전에 타당성의 체크를의해 무효인 값의 경우는 예외가 발생 됩니다. 배열이 비어있는 경우, 변경 내용은 적용되지 않습니다.

파라미터:

fieldNames - 필드명의 문자 배열. 배열 및 배열 요소는 null 이외

fieldValues - 대응하는 필드값로부터 완성되는 객체 배열. 배열은 null 이외. 배열 요소는 null인 경우도 있다

예외:

RuntimeOperationsException - 필드명 또는 필드값이 부정한 경우. 필드명, 필드값 모두, null은 사용할 수 없다. 배열의 길이는 일치하고 있을 필요가 있다. 어떠한 이유로써 기술자의 작성에 실패했을 경우, 이 예외가 발생되는

관련 항목:

getFields()

clone

Object  clone()
             throws RuntimeOperationsException 

새로운 Descriptor (Descriptor 복제)를 리턴합니다.

예외:

RuntimeOperationsException - 필드명 또는 필드값이 부정한 경우. 어떠한 이유로써 기술자의 작성에 실패했을 경우, 이 예외가 Throw 된다

isValid

boolean isValid()
                throws RuntimeOperationsException 

모든 필드의 유효한 값에 이름이 부여되고 있는 경우, true를 리턴합니다.

반환값:

값이 유효한 경우는 true

예외:

RuntimeOperationsException - 어떠한 이유로써 타당성 체크에 실패했을 경우, 이 예외가 Throw 된다