com.ibm.streams.operator
Enum StreamingData.Punctuation
- java.lang.Object
-
- java.lang.Enum<StreamingData.Punctuation>
-
- com.ibm.streams.operator.StreamingData.Punctuation
-
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Comparable<StreamingData.Punctuation>
- Enclosing interface:
- StreamingData
public static enum StreamingData.Punctuation extends java.lang.Enum<StreamingData.Punctuation>
Enumeration for punctuation marks.Punctuation marks for input ports are received by an operator's
processPunctuation
method.Punctuation marks are submitted to output ports using the
punctuate
method.
-
-
Enum Constant Summary
Enum Constants Enum Constant and Description FINAL_MARKER
Mark representing no more tuples or punctuation will be handled by a port.NON_EXISTENT
No punctuation, will be ignored by StreamingOutput.punctuate().WINDOW_MARKER
Mark representing a window boundary.
-
Method Summary
Methods Modifier and Type Method and Description static StreamingData.Punctuation
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static StreamingData.Punctuation[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
NON_EXISTENT
public static final StreamingData.Punctuation NON_EXISTENT
No punctuation, will be ignored by StreamingOutput.punctuate().
-
WINDOW_MARKER
public static final StreamingData.Punctuation WINDOW_MARKER
Mark representing a window boundary.
-
FINAL_MARKER
public static final StreamingData.Punctuation FINAL_MARKER
Mark representing no more tuples or punctuation will be handled by a port.Once a
FINAL_MARKER
is received for an input port, the operator will not receive any further calls to itsprocess
andprocessPunctuation
for that input port (StreamingInput
instance).After an operator submits a
FINAL_MARKER
to an output port, any tuples or punctuation marks submitted to that port are silently discarded.
-
-
Method Detail
-
values
public static StreamingData.Punctuation[] 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 (StreamingData.Punctuation c : StreamingData.Punctuation.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static StreamingData.Punctuation 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 namejava.lang.NullPointerException
- if the argument is null
-
-