ConfigModel.Property (Payara Project 6.2023.2 API)

java.lang.Object
- org.jvnet.hk2.config.ConfigModel.Property

Direct Known Subclasses:: ConfigModel.Node

Enclosing class:: ConfigModel

public abstract static class ConfigModel.Property
extends Object

Field Summary

Fields
Modifier and Type Field Description

List<String> annotations

String xmlName

Constructor Summary

Constructors
Modifier Constructor Description

protected Property(String xmlName)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract Object`	`get(Dom dom, Type returnType)`	Gets the value from `Dom` in the specified type.
`List<String>`	`getAnnotations()`
`abstract boolean`	`isCollection()`	Is multiple values allowed?
`abstract boolean`	`isLeaf()`
`abstract void`	`set(Dom dom, Object arg)`	Sets the value to `Dom`.
`String`	`xmlName()`	XML name of the property, like "abc-def".

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - annotations
```
public final List<String> annotations
```
  - xmlName
```
public final String xmlName
```
    See Also:
    
    xmlName()
- Constructor Detail
  - Property
```
protected Property(String xmlName)
```
- Method Detail
  - xmlName
```
public final String xmlName()
```
    XML name of the property, like "abc-def".
  - isLeaf
```
public abstract boolean isLeaf()
```
  - isCollection
```
public abstract boolean isCollection()
```
    Is multiple values allowed?
  - get
```
public abstract Object get(Dom dom,
                           Type returnType)
```
    Gets the value from Dom in the specified type.
    
    Parameters:
    
    dom - The DOM instance to get the value from.
    
    returnType - The expected type of the returned object. Valid types are (1) primitive and 'leaf' Java types, such as String, (2) ConfigBeanProxy, (3) Dom, and (4) collections of any of above.
  - set
```
public abstract void set(Dom dom,
                         Object arg)
```
    Sets the value to Dom.
    
    Parameters:
    
    arg - The new value. See the return type of the get method for the discussion of possible types.
  - getAnnotations
```
public List<String> getAnnotations()
```