com.github.rvesse.airline.builder

Class AliasBuilder<C>

java.lang.Object

com.github.rvesse.airline.builder.AbstractBuilder<T>

com.github.rvesse.airline.builder.AbstractChildBuilder<AliasMetadata,ParserMetadata<C>,ParserBuilder<C>>

com.github.rvesse.airline.builder.AliasBuilder<C>

Type Parameters:

C - Command type

public class AliasBuilder<C>
extends AbstractChildBuilder<AliasMetadata,ParserMetadata<C>,ParserBuilder<C>>

Builds a command alias

Author:

rvesse

Constructor Summary

Constructors

Constructor and Description
AliasBuilder(ParserBuilder<C> parserBuilder) Creates a new alias builder
AliasBuilder(ParserBuilder<C> parserBuilder, String name) Creates a new alias builder

Method Summary

Modifier and Type	Method and Description
AliasMetadata	build() Builds the alias metadata
AliasBuilder<C>	withArgument(String arg) Sets an argument for the alias
AliasBuilder<C>	withArguments(String... args) Sets arguments for the alias
AliasBuilder<C>	withName(String name) Sets the name for the alias

Methods inherited from class com.github.rvesse.airline.builder.AbstractChildBuilder

parent

Methods inherited from class com.github.rvesse.airline.builder.AbstractBuilder

checkNotBlank, checkNotEmpty, checkNotNull

Methods inherited from class java.lang.Object

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

Constructor Detail

AliasBuilder

public AliasBuilder(ParserBuilder<C> parserBuilder)

Creates a new alias builder

Parameters:

parserBuilder - Parser builder

name - Alias name

AliasBuilder

public AliasBuilder(ParserBuilder<C> parserBuilder,
                    String name)

Creates a new alias builder

Parameters:

parserBuilder - Parser builder

name - Alias name

Method Detail

withName

public AliasBuilder<C> withName(String name)

Sets the name for the alias

Parameters:

name - Alias name

Returns:

Alias builder

withArgument

public AliasBuilder<C> withArgument(String arg)

Sets an argument for the alias

Parameters:

arg - Argument

Returns:

Alias builder

withArguments

public AliasBuilder<C> withArguments(String... args)

Sets arguments for the alias

Parameters:

args - Arguments

Returns:

Alias builder

build

public AliasMetadata build()

Builds the alias metadata

Specified by:

build in class AbstractBuilder<AliasMetadata>

Returns:

Type instance