org.apache.flink.runtime.client

Class AbstractJobResult

java.lang.Object

org.apache.flink.runtime.client.AbstractJobResult

All Implemented Interfaces:

IOReadableWritable

Direct Known Subclasses:

JobCancelResult, JobProgressResult, JobSubmissionResult

public abstract class AbstractJobResult
extends Object
implements IOReadableWritable

A AbstractJobResult is the super class of all results to report the job operation. It contains a return code and an optional description.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractJobResult.ReturnCode The possible return codes for a job operation.

Constructor Summary

Constructors

Constructor and Description
AbstractJobResult() Construct a new abstract job result object.
AbstractJobResult(AbstractJobResult.ReturnCode returnCode, String description) Constructs a new abstract job result object and sets the description.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDescription() Returns the description containing further details in case of an error.
AbstractJobResult.ReturnCode	getReturnCode() Returns the return code of the job operation.
int	hashCode()
void	read(DataInputView in)
void	write(DataOutputView out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractJobResult

public AbstractJobResult(AbstractJobResult.ReturnCode returnCode,
                         String description)

Constructs a new abstract job result object and sets the description.

Parameters:

returnCode - the return code that shall be carried by this result object

description - the optional error description

AbstractJobResult

public AbstractJobResult()

Construct a new abstract job result object. This constructor is required for the deserialization process.

Method Detail

read

public void read(DataInputView in)
          throws IOException

Specified by:

read in interface IOReadableWritable

Throws:

IOException

write

public void write(DataOutputView out)
           throws IOException

Specified by:

write in interface IOReadableWritable

Throws:

IOException

getReturnCode

public AbstractJobResult.ReturnCode getReturnCode()

Returns the return code of the job operation.

Returns:

the return code of the job operation

getDescription

public String getDescription()

Returns the description containing further details in case of an error.

Returns:

the description of the job operation, possibly null

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object