org.elasticsearch.cluster.routing.allocation.command

Interface AllocationCommand.Factory<T extends AllocationCommand>

Type Parameters:

T - Type of AllocationCommands created by this AllocationCommand.Factory

All Known Implementing Classes:

AllocateAllocationCommand.Factory, CancelAllocationCommand.Factory, MoveAllocationCommand.Factory

Enclosing interface:

AllocationCommand

public static interface AllocationCommand.Factory<T extends AllocationCommand>

Factory to create AllocationCommands

Method Summary

Methods

Modifier and Type	Method and Description
T	fromXContent(XContentParser parser) Reads an AllocationCommand of type T from a XContentParser
T	readFrom(StreamInput in) Reads an AllocationCommand of type T from a StreamInput
void	toXContent(T command, XContentBuilder builder, ToXContent.Params params, String objectName) Writes an AllocationCommand using an XContentBuilder
void	writeTo(T command, StreamOutput out) Writes an AllocationCommand to a StreamOutput

Method Detail

readFrom

T readFrom(StreamInput in)
                                     throws IOException

Reads an AllocationCommand of type T from a StreamInput

Parameters:

in - StreamInput to read the AllocationCommand from

Returns:

AllocationCommand read from the StreamInput

Throws:

IOException - if something happens during reading

writeTo

void writeTo(T command,
           StreamOutput out)
             throws IOException

Writes an AllocationCommand to a StreamOutput

Parameters:

command - AllocationCommand to write

out - StreamOutput to write the AllocationCommand to

Throws:

IOException - if something happens during writing the command

fromXContent

T fromXContent(XContentParser parser)
                                         throws IOException

Reads an AllocationCommand of type T from a XContentParser

Parameters:

parser - XContentParser to use

Returns:

AllocationCommand read

Throws:

IOException - if something happens during reading

toXContent

void toXContent(T command,
              XContentBuilder builder,
              ToXContent.Params params,
              @Nullable
              String objectName)
                throws IOException

Writes an AllocationCommand using an XContentBuilder

Parameters:

command - AllocationCommand to write

builder - XContentBuilder to use

params - parameters to use when writing the command

objectName - object the encoding should be encased in, null means a plain object

Throws:

IOException - if something happens during writing the command