DXLVariable

java.lang.Object
- com.sodius.mdw.platform.doors.dxl.DXLVariable

All Implemented Interfaces:

DXLFragment

Direct Known Subclasses:

DXLVariable.FileOutput
```
public class DXLVariable
extends Object
implements DXLFragment
```
Declares a DXL variable. This fragment is a shorthand for the most used variable declarations that otherwise would be set directly in a DXLBufferFragment.
The DXLVariable.FileOutput enables to declare a file variable in which the DXL execution is supposed to write content, content which must then be retrieve in the Java code.

See Also:

DXLEngine, DXLBufferFragment, DXLVariable.FileOutput

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DXLVariable.FileOutput` Enables to declare a file variable in which the DXL execution is supposed to write content, content which must then be retrieved in the Java code.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DXLFragment`	`create(String name, boolean value)` Instantiates a fragment that declares a boolean variable.
`static DXLFragment`	`create(String name, File value)` Instantiates a fragment that declares a string variable whose value is a file path.
`static DXLFragment`	`create(String name, int value)` Instantiates a fragment that declares an int variable.
`static DXLFragment`	`create(String name, String value)` Instantiates a fragment that declares a String variable.
`static DXLFragment`	`createUnquoted(String name, String value)` Instantiates a fragment that declares a String variable whose value is already surrounded by quotes.
`void`	`write(Writer writer)` Writes the content of this fragment into the specified writer.

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

- Method Detail
  - create
```
public static DXLFragment create(String name,
                                 boolean value)
```
    Instantiates a fragment that declares a boolean variable.
    
    Parameters:
    
    name - the DXL variable name.
    
    value - the DXL variable value.
    
    Returns:
    
    the fragment that declares a boolean variable.
  - create
```
public static DXLFragment create(String name,
                                 int value)
```
    Instantiates a fragment that declares an int variable.
    
    Parameters:
    
    name - the DXL variable name.
    
    value - the DXL variable value.
    
    Returns:
    
    the fragment that declares an int variable.
  - create
```
public static DXLFragment create(String name,
                                 String value)
```
    Instantiates a fragment that declares a String variable.
    
    Parameters:
    
    name - the DXL variable name.
    
    value - the DXL variable value.
    
    Returns:
    
    the fragment that declares a String variable.
  - createUnquoted
```
public static DXLFragment createUnquoted(String name,
                                         String value)
```
    Instantiates a fragment that declares a String variable whose value is already surrounded by quotes.
    
    Parameters:
    
    name - the DXL variable name.
    
    value - the DXL variable value.
    
    Returns:
    
    the fragment that declares a boolean variable.
  - create
```
public static DXLFragment create(String name,
                                 File value)
```
    Instantiates a fragment that declares a string variable whose value is a file path.
    
    Parameters:
    
    name - the DXL variable name.
    
    value - a file path
    
    Returns:
    
    the fragment that declares a string variable whose value is a file path.
  - write
```
public void write(Writer writer)
           throws IOException
```
    Description copied from interface: DXLFragment
    
    Writes the content of this fragment into the specified writer. This method is called by the DXLEngine when combining fragments into a DXL file.
    
    Specified by:
    
    write in interface DXLFragment
    
    Parameters:
    
    writer - the writer in which to output the content of the fragment.
    
    Throws:
    
    IOException - if the content cannot be written.

Class DXLVariable

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

create

create

createUnquoted

create

write