com.ibm.pdp.maf.rpp.pac.common
Enum CommentsInsertionOptionValues

java.lang.Object
  extended by java.lang.Enum<CommentsInsertionOptionValues>
      extended by com.ibm.pdp.maf.rpp.pac.common.CommentsInsertionOptionValues
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<CommentsInsertionOptionValues>

public enum CommentsInsertionOptionValues
extends java.lang.Enum<CommentsInsertionOptionValues>

List of options for comments insertion in generated programs.


Enum Constant Summary
_N
          

Default option when the Library is created.

_O
          

Same as the Y value.

_S
          

The titles and frames of functions or subfunctions, and the inserted comments ('*' operator) are ignored at generation time.

_Y
           
 
Method Summary
static CommentsInsertionOptionValues valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static CommentsInsertionOptionValues[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

_N

public static final CommentsInsertionOptionValues _N

Default option when the Library is created. Same as the S value. However for the Pacbench C/S and OLSD functions, the inserted comments lines ('*' operator) are included in the generated COBOL.


_O

public static final CommentsInsertionOptionValues _O

Same as the Y value. However in the Batch Applications function, the punctuation of comments is not calculated; it varies according to the block type present on these lines.


_S

public static final CommentsInsertionOptionValues _S

The titles and frames of functions or subfunctions, and the inserted comments ('*' operator) are ignored at generation time.


_Y

public static final CommentsInsertionOptionValues _Y

The titles and frames of functions or subfunctions, and the inserted comments (' * ' operator) are present in the generated COBOL.

Moreover punctuation is automatically calculated for comment lines which do not include a block type.

The block type of the next processing is then taken into account for this calculation.

Method Detail

valueOf

public static CommentsInsertionOptionValues valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

values

public static CommentsInsertionOptionValues[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (CommentsInsertionOptionValues c : CommentsInsertionOptionValues.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared