javax.management.modelmbean
클래스 DescriptorSupport

java.lang.Object 
  javax.management.modelmbean.DescriptorSupport

모든 구현된 인터페이스:

Serializable, Cloneable, Descriptor

public class DescriptorSupport
extends Object 
implements Descriptor 

이 클래스는 ModelMBean 요소의 메타데이타셋트를 나타냅니다. 기술자는 ModelMBeanInfo, ModelMBeanNotificationInfo, ModelMBeanAttributeInfo, ModelMBeanConstructorInfo 및 ModelMBeanParameterInfo 일부입니다.

기술자는 복수의 필드로부터 완성됩니다. 각 필드는 fieldname=fieldvalue 형식이 됩니다. 필드명의 대문자와 소문자는 구별되지 않습니다. 필드명을 대문자로 입력했을 경우는 필드값도 대문자, 필드명을 소문자로 입력했을 경우는 필드값도 소문자가 됩니다.

모든 필드의 이름과 값이 미정도리가 아닙니다. 임의의 프로그램으로 새로운 필드를 정의해, 추가할 수 있습니다 . 일부의 필드는 구현의 정합성을 확보해, ModelMBeanInfo, ModelMBeanAttributeInfo, ModelMBeanConstructorInfo, ModelMBeanNotificationInfo, ModelMBeanOperationInfo 및 ModelMBean 클래스에 한 지원를 얻기 위해, 정의가 끝난 상태가 되어 있습니다.

도입된 버전 :

1.5

관련 항목:

직렬화 된 형식

생성자 개요

DescriptorSupport ()
기술자의 디폴트의 생성자 입니다.

DescriptorSupport (DescriptorSupport inDescr)
Descriptor를 파라미터로서 취하는 기술자의 생성자 입니다.

DescriptorSupport (int initNumFields)
기술자의 생성자 입니다.

DescriptorSupport (String inStr)
XML String를 취하는 기술자의 생성자 입니다.

DescriptorSupport (String [] fields)
fieldName=fieldValue 형식의 필드를 잡는 생성자 입니다.

DescriptorSupport (String [] fieldNames, Object [] fieldValues)
필드명과 필드값을 받는 생성자 입니다.

메서드 개요

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

클래스 java.lang. Object 로부터 상속된 메서드

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

생성자 상세

DescriptorSupport

public DescriptorSupport()

기술자의 디폴트의 생성자 입니다. 디폴트의 초기 기술자 사이즈는 20 입니다만, 이 사이즈는 필요에 따라서 커집니다.
작성된 비어있는 기술자는 무효인 기술자입니다 (isValid 메서드가 false를 돌려준다).

DescriptorSupport

public DescriptorSupport(int initNumFields)
                  throws MBeanException,

                         RuntimeOperationsException 

기술자의 생성자 입니다. 기술자 필드를 포함하는 Map 초기 용량이 파라미터가 됩니다. 용량은 필요에 따라서 증가합니다.
작성된 비어있는 기술자는 무효인 기술자입니다 (isValid 가 false를 돌려준다).

파라미터:

initNumFields - 기술자 필드를 포함하는 Map 초기 용량

예외:

RuntimeOperationsException - initNumFields 값이 무효 (<= 0)인 경우

MBeanException - 분산 통신 Exception을 랩 한다

DescriptorSupport

public DescriptorSupport(DescriptorSupport  inDescr)

Descriptor를 파라미터로서 취하는 기술자의 생성자 입니다. 파라미터로서 건네받은 기술자의 값에 초기화되는 새로운 기술자를 작성합니다.

파라미터:

inDescr - 구축이 끝난 기술자의 초기화에 사용되는 기술자. null인 경우, 또는 기술자 필드가 포함되지 않는 경우, 비어있는 Descriptor가 작성된다

DescriptorSupport

public DescriptorSupport(String  inStr)
                  throws MBeanException,

                         RuntimeOperationsException,

                         XMLParseException 

XML String를 취하는 기술자의 생성자 입니다.

XML 캐릭터 라인의 형식은 미정도리입니다만, toXMLString() 에 의해 기존의 기술자상에 리턴된 캐릭터 라인으로 이 생성자를 사용해 동등의 기술자를 인스턴스화할 수 있는 구현이 아니면 안됩니다.

이 구현에서는 모든 필드값는 String 로서 작성됩니다. 필드값이 String가 아닌 경우, 프로그래머는 이러한 필드를 올바르고 리셋 또는 변환할 필요가 있습니다.

파라미터:

inStr - 이 Descriptor read 사용되는 XML 형식의 캐릭터 라인. 이 캐릭터 라인의 형식은 미정도리이지만, toXMLString() 메서드에 의해 기존의 기술자상에 리턴된 캐릭터 라인으로 이 생성자를 사용해 동등의 기술자를 인스턴스화할 수 있는 구현이 아니면 안된다

예외:

RuntimeOperationsException - 파라미터로서 건네받는 String inStr가 null인 경우

XMLParseException - 입력 String 해석시에 XML 해석 관련의 문제가 발생했을 경우

MBeanException - 분산 통신 Exception을 랩 한다

DescriptorSupport

public DescriptorSupport(String [] fieldNames,
                         Object [] fieldValues)
                  throws RuntimeOperationsException 

필드명과 필드값을 받는 생성자 입니다. 배열 및 배열 요소는 null 이외에 됩니다.

파라미터:

fieldNames - 필드명의 캐릭터 라인 배열. 이 배열의 배열 요소는 null 이외

fieldValues - 대응하는 필드값의 객체 배열. 배열 요소는 null 이라도 좋다. fieldValue는 isValid 메서드의 정의 대로fieldName에 대해서 유효한 값이 아니면 안된다

주: 파라미터의 배열 사이즈가 일치하고 있을 필요가 있습니다. 배열이 null 또는 비어있는 경우, 비어있는 기술자가 작성됩니다.

예외:

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

DescriptorSupport

public DescriptorSupport(String [] fields)

fieldName=fieldValue 형식의 필드를 잡는 생성자 입니다.

파라미터:

fields - 필드명 및 필드값을 포함한 요소를 가지는 캐릭터 라인 배열. 이 배열이 null 또는 비어있는 경우, 디폴트의 생성자가 실행된다. null 캐릭터 라인과 공문자열은 무시된다

모든 필드값는 String가 됩니다. 필드값이 String가 아닌 경우, 프로그래머는 이러한 필드를 올바르고 리셋 또는 변환할 필요가 있습니다.

주: 각 캐릭터 라인은 fieldName=fieldValue 형식을 취할 필요가 있습니다.

예외:

RuntimeOperationsException - 필드 Name 또는 필드 Value가 부정한 경우. 필드에는 「=」이 포함되지 않으면 안 된다. 「=fieldValue」, 「fieldName」, 「fieldValue」는 무효. 또, FieldName는 null 이외. 「fieldName=」의 경우, 값은 null이 된다. 어떠한 이유로써 기술자의 작성에 실패했을 경우, 이 예외가 Throw 된다

메서드의 상세

getFieldValue

public Object  getFieldValue(String  inFieldName)
                     throws RuntimeOperationsException 

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

정의:

인터페이스 Descriptor 내의 getFieldValue

파라미터:

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

반환값:

필드값을 나타내는 Object

예외:

RuntimeOperationsException - 필드 Name가 부정 (null 또는 공문자열)인 경우

setField

public void setField(String  inFieldName,
                     Object  fieldValue)
              throws RuntimeOperationsException 

특정의 필드명의 캐릭터 라인치를 설정합니다. isValid 메서드의 정의에 따라, 그 필드에 대해서 유효한 값을 설정할 필요가 있습니다. 필드가 존재하지 않는 경우, Descriptor 말미에 추가됩니다. 필드가 존재하는 경우, 값을 옮겨놓을 수 있습니다.

정의:

인터페이스 Descriptor 내의 setField

파라미터:

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

fieldValue - 필드명으로서 설정되는 값. null 나 공문자열은 사용할 수 없다

예외:

RuntimeOperationsException - 필드 Name 값이 부정한 경우

getFields

public String [] getFields()

기술자내의 모든 필드를 리턴합니다. 리턴된 차례는 필드의 설정순서와는 다릅니다.

정의:

인터페이스 Descriptor 내의 getFields

반환값:

fieldName=fieldValue 형식의 필드의 캐릭터 라인 배열. 기술자내에 필드가 존재하지 않는 경우, 비어있는 String 배열이 리턴된다. fieldValue가 String가 아닌 경우, toString() 메서드가 불려 간다. 그 반환값은 괄호에 둘러싸인 필드의 값으로 해서 사용되는

관련 항목:

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

getFieldNames

public String [] getFieldNames()

기술자내의 모든 필드명을 리턴합니다. 리턴된 차례는 필드의 설정순서와는 다릅니다.

정의:

인터페이스 Descriptor 내의 getFieldNames

반환값:

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

getFieldValues

public Object [] getFieldValues(String [] fieldNames)

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

정의:

인터페이스 Descriptor 내의 getFieldValues

파라미터:

fieldNames - 값이 리턴된 필드의 이름에서 완성되는 캐릭터 라인 배열.
배열이 비어있는 경우, 비어있는 배열이 리턴된다.
배열이 null인 경우, 모든 값이 리턴된다. 리턴된 차례는 필드의 설정순서와는 다르다.
배열내의 필드명이 존재하지 않는 경우, 대응하는 배열 요소의 위치에 null이 리턴된다

반환값:

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

setFields

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

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

정의:

인터페이스 Descriptor 내의 setFields

파라미터:

fieldNames - 필드명의 캐릭터 라인 배열. 배열 및 배열 요소는 null 이외

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

예외:

RuntimeOperationsException - 필드명 또는 필드값의 값이 부정한 경우. 모두 null은 불가. 배열의 길이는 일치하고 있을 필요가 있는

관련 항목:

getFields()

clone

public Object  clone()
             throws RuntimeOperationsException 

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

정의:

인터페이스 Descriptor 내의 clone

오버라이드(override):

클래스 Object 내의 clone

반환값:

이 인스턴스의 복제

예외:

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

관련 항목:

Cloneable

removeField

public void removeField(String  fieldName)

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

정의:

인터페이스 Descriptor 내의 removeField

파라미터:

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

isValid

public boolean isValid()
                throws RuntimeOperationsException 

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

이 구현은 디렉토리 또는 검색 서비스와의 상호 운용성을 지원 하지 않습니다. 사양에의해 "export" 필드의 체크는 행해지지 않습니다.

다음의 경우, 이 구현은 false를 리턴합니다.

• 이름과 descriptorType fieldName가 미정도리, null, 공문자열, 또는 String 이외의 경우
• 클래스, 롤, getMethod, setMethod fieldName에 null 또는 String 이외가 정의되고 있는 경우
• persistPeriod, currencyTimeLimit, lastUpdatedTimeStamp, lastReturnedTimeStamp에 null, Numeric String, 또는 Numeric Value >= -1 이외가 정의되고 있는 경우
• 로그 fieldName에 null, Boolean 이외, 또는 t, f, true, false 몇개의 값 (대문자와 소문자는 구별되지 않는다)을 가지는 String 이외가 정의되고 있는 경우
• 가시 fieldName에 null, Numeric String 이외, 또는 Numeric Value >= 1 및 <=4 이외가 정의되고 있는 경우
• 중요도 fieldName에 null, Numeric String 이외, 또는 Numeric Value >= 0 및 <=6 이외가 정의되고 있는 경우
  
• persistPolicy fieldName에 null이 정의되고 있는 경우, 또는 OnUpdate, OnTimer, NoMoreOftenThan, Always, Never 이외의 String (대문자와 소문자는 구별되지 않는다)가 정의되고 있는 경우
  
  

정의:

인터페이스 Descriptor 내의 isValid

반환값:

값이 유효한 경우는 true

예외:

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

toXMLString

public String  toXMLString()

기술자를 나타내는 XML String를 리턴합니다.

형식은 미정도리입니다만, 생성자 DescriptorSupport(String inStr)를 사용해 인스턴스화할 때, 이 메서드에 의해 리턴된 캐릭터 라인으로 동등의 기술자를 구축할 수 있는 구현이 아니면 안됩니다.

필드가 String 객체가 아닌 경우, toString()가 불려가 값이 작성됩니다. 값은 괄호에 둘러싸인 형식이 됩니다. 이러한 객체가 유의의 형식의 toString()를 지원 하도록 설정되어 있어, 같은 형식의 String를 받아들이는 일치한 생성자를 가지고 있지 않은 경우, 이러한 객체를 재구축 할 수 없는 것이 있습니다.

기술자가 비어있는 경우, String 로서 <Descriptor></Descriptor>가 리턴됩니다 .

반환값:

XML 캐릭터 라인

예외:

RuntimeOperationsException - 필드명 또는 필드값이 부정한 경우. 어떠한 이유로써 XML 형식의 캐릭터 라인의 작성에 실패했을 경우, 이 예외가 Throw 된다

toString

public String  toString()

기술자를 나타내는 인간이 읽을 수 있는 형식의 캐릭터 라인을 리턴합니다. 이 캐릭터 라인의 형식은 「fieldName=fieldValue, fieldName2=fieldValue2,...」(와)과 같이 됩니다.
기술자내에 필드가 존재하지 않는 경우, 비어있는 String가 리턴됩니다 .
fieldValue가 객체인 경우, toString() 메서드가 호출됩니다. 반환값은 괄호에 둘러싸인 필드의 값으로 해서 사용됩니다.

오버라이드(override):

클래스 Object 내의 toString

반환값:

이 객체의 캐릭터 라인 표현

예외:

RuntimeOperationsException - 필드명 또는 필드값이 부정한 경우. 어떠한 이유로써 기술자의 캐릭터 라인에 문제가 발생했을 경우, 이 예외가 Throw 된다