UnnamedStreams (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.util.UnnamedStreams

All Implemented Interfaces:

Scopeable
```
public class UnnamedStreams
extends java.lang.Object
implements Scopeable
```
Stores state and provides functional support for the unnamed in and unnamed out streams.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`UnnamedStreams.ContextContainer` Simple container that stores and returns a context-local instance of the global work area.
`private static class`	`UnnamedStreams.InputCloser` Finalizable class which will perform a closeIn call only if this class is in the top of the closerIn stack - this way we make sure there are not possible two subsequent calls to the closeIn statement.
`private static class`	`UnnamedStreams.OutputCloser` Finalizable class which will perform a closeOut call only if this class is in the top of the closerOut stack - this way we make sure there are not possible two subsequent calls to the closeOut statement.
`private static class`	`UnnamedStreams.WorkArea` Stores global data relating to the state of the current context.

Field Summary

Fields
Modifier and Type	Field and Description
`private UnnamedStreams.WorkArea`	`wa` The state for this instance.
`private static UnnamedStreams.ContextContainer`	`work` Stores context-local state variables.

Constructor Summary

Constructors
Modifier Constructor and Description

private UnnamedStreams()
Private constructor so external code cannot instantiate this class.

Constructors
Modifier	Constructor and Description
`private`	`UnnamedStreams()` Private constructor so external code cannot instantiate this class.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`assignBoth(Stream stream)` Assigns the streams representing both the unnamed output stream and the unnamed input stream.
`static void`	`assignIn(Stream in)` Assigns the stream representing the unnamed input stream.
`private static void`	`assignInWorker(UnnamedStreams.WorkArea wa, Stream in, boolean register)` Assigns the stream representing the unnamed input stream.
`static void`	`assignOut(Stream out)` Assigns the stream representing the unnamed output stream.
`static void`	`assignOut(Stream out, java.lang.String lobDir)` Assigns the stream representing the unnamed output stream.
`private static void`	`assignOutWorker(UnnamedStreams.WorkArea wa, Stream out, boolean register)` Assigns the stream representing the unnamed output stream.
`static void`	`closeBoth()` Closes both the unnamed input stream and the unnamed output stream.
`static void`	`closeIn()` Closes the stream representing the unnamed input stream.
`private static void`	`closeInInt(UnnamedStreams.WorkArea wa)` Closes the stream representing the unnamed input stream.
`static void`	`closeOut()` Closes the stream representing the unnamed output stream.
`private static void`	`closeOutInt(UnnamedStreams.WorkArea wa)` Closes the stream representing the unnamed output stream.
`ScopeId`	`getScopeId()` Get the `ScopeId` for the instance.
`static Stream`	`input()` Gets the stream representing the unnamed input stream.
`static boolean`	`isOut()` State of the output side of the unnamed stream.
`private static Stream`	`makeSafe(Stream safe)` Returns the given stream if it is not `null`, otherwise it returns a safe stream instance that can be used for operations that should effectively be a `NOP`.
`static Stream`	`output()` Gets the stream representing the unnamed output stream.
`static Stream`	`safeInput()` Gets the stream representing the unnamed input stream or a safe stream instance that can be used for operations that should effectively be `NOP`.
`static Stream`	`safeOutput()` Gets the stream representing the unnamed output stream or a safe stream instance that can be used for operations that should effectively be `NOP`.
`void`	`scopeDeleted()` Provides notification that the external procedure scope has been deleted.
`void`	`scopeFinished()` Provides a notification that a scope is about to be exited.
`void`	`scopeStart(BlockDefinition block)` Provides a notification that a new scope is about to be entered.

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

- Field Detail
  - work
```
private static final UnnamedStreams.ContextContainer work
```
    Stores context-local state variables.
  - wa
```
private final UnnamedStreams.WorkArea wa
```
    The state for this instance.
- Constructor Detail
  - UnnamedStreams
```
private UnnamedStreams()
```
    Private constructor so external code cannot instantiate this class.
- Method Detail
  - input
```
public static Stream input()
```
    Gets the stream representing the unnamed input stream.
    
    Returns:
    
    The unnamed input stream or null if the unnamed input stream has not been explicitly redirected.
  - safeInput
```
public static Stream safeInput()
```
    Gets the stream representing the unnamed input stream or a safe stream instance that can be used for operations that should effectively be NOP.
    
    Returns:
    
    The unnamed input stream to which input is redirected or a NullStream instance if the unnamed input stream has not been explicitly redirected.
  - assignIn
```
public static void assignIn(Stream in)
```
    Assigns the stream representing the unnamed input stream. Closes any unnamed input stream that is already open. Calls assignInWorker(Stream,true).
    
    Parameters:
    
    in - The unnamed input stream to set or null if any current input stream redirection is to be cleared.
  - closeIn
```
public static void closeIn()
```
    Closes the stream representing the unnamed input stream. This will restore the default input stream for the current top level scope, which may be null (if the current redirection when the scope opened was null).
  - output
```
public static Stream output()
```
    Gets the stream representing the unnamed output stream.
    
    Returns:
    
    The unnamed output stream or null if the unnamed output stream has not been explicitly redirected.
  - safeOutput
```
public static Stream safeOutput()
```
    Gets the stream representing the unnamed output stream or a safe stream instance that can be used for operations that should effectively be NOP.
    
    Returns:
    
    The unnamed output stream to which output is redirected or a NullStream instance if the unnamed output stream has not been explicitly redirected.
  - assignOut
```
public static void assignOut(Stream out,
                             java.lang.String lobDir)
```
    Assigns the stream representing the unnamed output stream. Closes any stream that is already open. Calls assignOutWorker(Stream,true).
    
    Parameters:
    
    out - The unnamed output stream to set or null if any current output stream redirection is to be cleared.
    
    lobDir - The folder where to write any CLOB or BLOB fields.
  - assignOut
```
public static void assignOut(Stream out)
```
    Assigns the stream representing the unnamed output stream. Closes any stream that is already open. Calls assignOutWorker(Stream,true).
    
    Parameters:
    
    out - The unnamed output stream to set or null if any current output stream redirection is to be cleared.
  - closeOut
```
public static void closeOut()
```
    Closes the stream representing the unnamed output stream. This will restore the default output stream for the current top level scope, which may be null (if the current redirection when the scope opened was null).
  - assignBoth
```
public static void assignBoth(Stream stream)
```
    Assigns the streams representing both the unnamed output stream and the unnamed input stream. Closes the input or output streams if either are already open.
    
    Parameters:
    
    stream - The unnamed output stream to set or null if any current output stream redirection is to be cleared.
  - closeBoth
```
public static void closeBoth()
```
    Closes both the unnamed input stream and the unnamed output stream.
  - scopeStart
```
public void scopeStart(BlockDefinition block)
```
    Provides a notification that a new scope is about to be entered. Used to store the new default input and output streams for this scope.
    
    Specified by:
    
    scopeStart in interface Scopeable
    
    Parameters:
    
    block - The explicit block definition which required this notification.
  - scopeFinished
```
public void scopeFinished()
```
    Provides a notification that a scope is about to be exited. Used to clear the default input and output streams back to the previous scope's versions, unless it is the responsibility of executeOnReturn.
    
    Specified by:
    
    scopeFinished in interface Scopeable
  - scopeDeleted
```
public void scopeDeleted()
```
    Provides notification that the external procedure scope has been deleted.
    This is a no-op for unnamed streams.
    
    Specified by:
    
    scopeDeleted in interface Scopeable
  - getScopeId
```
public ScopeId getScopeId()
```
    Get the ScopeId for the instance.
    
    Specified by:
    
    getScopeId in interface Scopeable
    
    Returns:
    
    ScopeId.UNNAMED_STREAMS.
  - isOut
```
public static boolean isOut()
```
    State of the output side of the unnamed stream.
    
    Returns:
    
    true if the output side of the stream is active.
  - makeSafe
```
private static Stream makeSafe(Stream safe)
```
    Returns the given stream if it is not null, otherwise it returns a safe stream instance that can be used for operations that should effectively be a NOP.
    
    Parameters:
    
    safe - The stream to check.
    
    Returns:
    
    The unnamed input stream given or a NullStream instance if the given stream is null.
  - assignInWorker
```
private static void assignInWorker(UnnamedStreams.WorkArea wa,
                                   Stream in,
                                   boolean register)
```
    Assigns the stream representing the unnamed input stream. Closes any unnamed input stream that is already open.
    
    Parameters:
    
    wa - The context-local state.
    
    in - The unnamed input stream to set or null if any current input stream redirection is to be cleared.
    
    register - If true and the stream parameter is non-null, then a call to registerTopLevelFinalizable will be performed.
  - assignOutWorker
```
private static void assignOutWorker(UnnamedStreams.WorkArea wa,
                                    Stream out,
                                    boolean register)
```
    Assigns the stream representing the unnamed output stream. Closes any stream that is already open.
    
    Parameters:
    
    wa - The context-local state.
    
    out - The unnamed output stream to set or null if any current output stream redirection is to be cleared.
    
    register - If true and the stream parameter is non-null, then a call to registerTopLevelFinalizable will be performed.
  - closeInInt
```
private static void closeInInt(UnnamedStreams.WorkArea wa)
```
    Closes the stream representing the unnamed input stream. This will restore the default input stream for the current top level scope, which may be null (if the current redirection when the scope opened was null).
    
    Parameters:
    
    wa - The context-local state.
  - closeOutInt
```
private static void closeOutInt(UnnamedStreams.WorkArea wa)
```
    Closes the stream representing the unnamed output stream. This will restore the default output stream for the current top level scope, which may be null (if the current redirection when the scope opened was null).
    
    Parameters:
    
    wa - The context-local state.

Class UnnamedStreams

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

work

wa

Constructor Detail

UnnamedStreams

Method Detail

input

safeInput

assignIn

closeIn

output

safeOutput

assignOut

assignOut

closeOut

assignBoth

closeBoth

scopeStart

scopeFinished

scopeDeleted

getScopeId

isOut

makeSafe

assignInWorker

assignOutWorker

closeInInt

closeOutInt