ParameterDefinition (error-reporting-java 1.0.1 API)

java.lang.Object
- com.exasol.errorreporting.ParameterDefinition

public class ParameterDefinition
extends Object

The class models an error code parameter.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ParameterDefinition.Builder
Builder for an error code ParameterDefinition.

Field Summary

Fields
Modifier and Type Field Description

static ParameterDefinition UNDEFINED_PARAMETER
Replacement Parameter in case a parameter is missing its name

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ParameterDefinition.Builder`	`builder(String name)`	Create a builder for an error code `ParameterDefinition`.
`String`	`getDescription()`	Get the parameter description.
`String`	`getName()`	Get the parameter name.
`Object`	`getValue()`	Get the parameter value.
`boolean`	`hasDescription()`	Check if the description is set.
`boolean`	`hasName()`	Check if the parameter has a name.
`boolean`	`hasValue()`	Check if the value is set.
`String`	`toString()`

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

- Field Detail
  - UNDEFINED_PARAMETER
```
public static final ParameterDefinition UNDEFINED_PARAMETER
```
    Replacement Parameter in case a parameter is missing its name
- Method Detail
  - builder
```
public static ParameterDefinition.Builder builder(String name)
```
    Create a builder for an error code ParameterDefinition.
    
    Parameters:
    
    name - name of the parameter
    
    Returns:
    
    parameter builder
  - getName
```
public String getName()
```
    Get the parameter name.
    
    Returns:
    
    name of the parameter
  - getValue
```
public Object getValue()
```
    Get the parameter value.
    
    Returns:
    
    value assigned to the parameter
  - getDescription
```
public String getDescription()
```
    Get the parameter description.
    
    Returns:
    
    description of the parameter
  - hasName
```
public boolean hasName()
```
    Check if the parameter has a name.
    
    Returns:
    
    true if the name is set.
  - hasValue
```
public boolean hasValue()
```
    Check if the value is set.
    
    Returns:
    
    true if the value is set.
  - hasDescription
```
public boolean hasDescription()
```
    Check if the description is set.
    
    Returns:
    
    true if the description is set
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object