MappingRules.PropertyFormat.Scope (Composum Nodes API (Commons) 4.3.3 API)

java.lang.Object
- java.lang.Enum<MappingRules.PropertyFormat.Scope>
- - com.composum.sling.core.mapping.MappingRules.PropertyFormat.Scope

All Implemented Interfaces:

Serializable, Comparable<MappingRules.PropertyFormat.Scope>

Enclosing class:

MappingRules.PropertyFormat
```
public static enum MappingRules.PropertyFormat.Scope
extends Enum<MappingRules.PropertyFormat.Scope>
```
the scope for the external property representation - value: use a short name / value - attribute format with type embedded ... in the string value (a '{type}...' string formatting is used) - object: use an object for each property with name, type, value and multi attributes - definition: the extended object format with additional definition attributes (auto, protected)

Enum Constant Summary

Enum Constants
Enum Constant Description

definition

object

value

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static MappingRules.PropertyFormat.Scope`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static MappingRules.PropertyFormat.Scope[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - value
```
public static final MappingRules.PropertyFormat.Scope value
```
  - object
```
public static final MappingRules.PropertyFormat.Scope object
```
  - definition
```
public static final MappingRules.PropertyFormat.Scope definition
```
- Method Detail
  - values
```
public static MappingRules.PropertyFormat.Scope[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (MappingRules.PropertyFormat.Scope c : MappingRules.PropertyFormat.Scope.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static MappingRules.PropertyFormat.Scope valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null