Package wtf.choco.veinminer.documentation

Class ProtocolMessageDocumentation.Builder

java.lang.Object

wtf.choco.veinminer.documentation.ProtocolMessageDocumentation.Builder

Enclosing class:

ProtocolMessageDocumentation

public static final class ProtocolMessageDocumentation.Builder
extends Object

A builder for ProtocolMessageDocumentation instances.

Method Summary

Modifier and Type	Method	Description
ProtocolMessageDocumentation.Builder	description(String description)	Set the description of the protocol message.
ProtocolMessageDocumentation.Builder	field(String expectedType, String name, String description)	Add a new field to the protocol message.
ProtocolMessageDocumentation.Builder	name(String name)	Set the name of the protocol message.

Methods inherited from class java.lang.Object

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

Method Details

name

public ProtocolMessageDocumentation.Builder name(String name)

Set the name of the protocol message.

Parameters:

name - the name to set

Returns:

this instance. Allows for chained method calls

description

public ProtocolMessageDocumentation.Builder description(String description)

Set the description of the protocol message.

Parameters:

description - the description to set

Returns:

this instance. Allows for chained method calls

field

public ProtocolMessageDocumentation.Builder field(String expectedType,
 String name,
 String description)

Add a new field to the protocol message.

The order of invocation of this method is significant. Fields added first will be listed first in the table.

Parameters:

expectedType - the expected field type (see MessageField for constants)

name - the name of the field

description - the description of the field

Returns:

this instance. Allows for chained method calls