Dimensionality (Groovy Documentation)

Summary:
Enum constants
Field
Method

life.qbic.datamodel.dtos.imaging.properties.Dimensionality

A DTO to describe the dimensionality of an image This class should be used whenever the dimension of an image or in the image context needs to be described @since: 1.10.0 @author: Jennifer Bödker

Enum Constants Summary

Enum constants classes
Enum constant	Description
`ThreeDimensional`
`TwoDimensional`

Field Summary

Fields
Modifiers	Name	Description
`private java.lang.String`	`value`	Contains the String representation of a dimensionality item.

Constructor Summary

Constructors
Constructor and description
`Dimensionality (java.lang.String value)` A DTO to describe the dimensionality of an image

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.String`	`getValue()` The String representation of the dimensionality item.
	`java.lang.String`	`toString()` The `toString()` method is overridden to return the String representation of a dimensionality item.
`null`	`Dimensionality`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`null`	`Dimensionality[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Enum Constant Detail
  - Dimensionality ThreeDimensional
  - Dimensionality TwoDimensional
- Field Detail
  - private final java.lang.String value
    
    Contains the String representation of a dimensionality item.
- Constructor Detail
  - Dimensionality(java.lang.String value)
    
    A DTO to describe the dimensionality of an image
    Parameters:
    value - Dimensionality.value
- Method Detail
  - java.lang.String getValue()
    
    The String representation of the dimensionality item.
    Returns:
    The value of the dimensionality item, which is its declarative String representation.
  - @java.lang.Override java.lang.String toString()
    
    The toString() method is overridden to return the String representation of a dimensionality item. This is equivalent to the getValue() return value.
    See Also:
    getValue()
    Returns:
    The String representation of the dimensionality item
  - Dimensionality valueOf(java.lang.String name)
    
    Returns the enum constant of this type with the specified name.
  - Dimensionality[] values()
    
    Returns an array containing the constants of this enum type, in the order they are declared.

Summary:
Enum constants
Field
Method

Groovy Documentation