VelocityContextItem (EASy-Producer Documentation API)

java.lang.Object
- net.ssehub.easy.instantiation.velocity.VelocityContextItem

Direct Known Subclasses:

VelocityCompoundAccess, VelocityContainerItem
```
public class VelocityContextItem
extends java.lang.Object
```
Datatype for initializing velocity's context. Stored the name and the related value of configured elements. Compounds will be flattened (using VelocityContextInitializer.SLOT_ACCESS).

Author:

Sascha El-Sharkawy

Field Summary

Fields
Modifier and Type Field Description

private java.lang.Object value

private java.lang.String variableName

Constructor Summary

Constructors
Constructor Description

VelocityContextItem(java.lang.String variableName, java.lang.Object value)
Sole constructor for this class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`(package private) java.lang.String`	`getName()`	Returns the name of the variable as it is used inside the code fragments.
`(package private) java.lang.Object`	`getValue()`	Returns the value which shall replace the name inside the code fragments.
`java.lang.String`	`toString()`	Returns `getValue()` as String.

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

- Field Detail
  - variableName
```
private java.lang.String variableName
```
  - value
```
private java.lang.Object value
```
- Constructor Detail
  - VelocityContextItem
```
public VelocityContextItem(java.lang.String variableName,
                           java.lang.Object value)
```
    Sole constructor for this class.
    
    Parameters:
    
    variableName - The name of a variable as it is used inside the code fragments.
    
    value - The value which shall replace the name.
- Method Detail
  - getName
```
java.lang.String getName()
```
    Returns the name of the variable as it is used inside the code fragments.
    
    Returns:
    
    The name of the variable as it is used inside the code fragments.
  - getValue
```
java.lang.Object getValue()
```
    Returns the value which shall replace the name inside the code fragments.
    
    Returns:
    
    The value which shall replace the name inside the code fragments
  - toString
```
public final java.lang.String toString()
```
    Returns getValue() as String. This facilitates the direct usage of the variable inside the code to insert its value as expected by an pre-processor.
    
    Overrides:
    
    toString in class java.lang.Object