me.lucko.commodore.file

Class CommodoreFileReader

java.lang.Object

me.lucko.commodore.file.CommodoreFileReader

public class CommodoreFileReader
extends Object

The '.commodore' file format is a simplified way of representing Brigadier command node trees in a string form.

This class provides a means to parse these files into real CommandNodes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommodoreFileReader.Builder Builder for CommodoreFileReader.

Field Summary

Fields

Modifier and Type	Field and Description
static CommodoreFileReader	INSTANCE A default instance of CommodoreFileReader.

Method Summary

Modifier and Type	Method and Description
static CommodoreFileReader.Builder	builder() Creates a new CommodoreFileReader builder.
<S> com.mojang.brigadier.tree.LiteralCommandNode<S>	parse(File file) Parses a LiteralCommandNode from a commodore file.
<S> com.mojang.brigadier.tree.LiteralCommandNode<S>	parse(InputStream inputStream) Parses a LiteralCommandNode from a commodore file.
<S> com.mojang.brigadier.tree.LiteralCommandNode<S>	parse(Path path) Parses a LiteralCommandNode from a commodore file.
<S> com.mojang.brigadier.tree.LiteralCommandNode<S>	parse(Reader reader) Parses a LiteralCommandNode from a commodore file.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final CommodoreFileReader INSTANCE

A default instance of CommodoreFileReader.

Method Detail

builder

public static CommodoreFileReader.Builder builder()

Creates a new CommodoreFileReader builder.

Returns:

a new builder

parse

public <S> com.mojang.brigadier.tree.LiteralCommandNode<S> parse(Reader reader)
                                                          throws IOException

Parses a LiteralCommandNode from a commodore file.

Type Parameters:

S - the command node sender type

Parameters:

reader - a reader for the file

Returns:

the command node

Throws:

IOException - if an error occurs whilst reading the file

RuntimeException - if an error occurs whilst lexing or parsing the file

parse

public <S> com.mojang.brigadier.tree.LiteralCommandNode<S> parse(InputStream inputStream)
                                                          throws IOException

Parses a LiteralCommandNode from a commodore file.

Type Parameters:

S - the command node sender type

Parameters:

inputStream - an inputStream for the file

Returns:

the command node

Throws:

IOException - if an error occurs whilst reading the file

RuntimeException - if an error occurs whilst lexing or parsing the file

parse

public <S> com.mojang.brigadier.tree.LiteralCommandNode<S> parse(Path path)
                                                          throws IOException

Parses a LiteralCommandNode from a commodore file.

Type Parameters:

S - the command node sender type

Parameters:

path - the path to the file

Returns:

the command node

Throws:

IOException - if an error occurs whilst reading the file

RuntimeException - if an error occurs whilst lexing or parsing the file

parse

public <S> com.mojang.brigadier.tree.LiteralCommandNode<S> parse(File file)
                                                          throws IOException

Parses a LiteralCommandNode from a commodore file.

Type Parameters:

S - the command node sender type

Parameters:

file - the file

Returns:

the command node

Throws:

IOException - if an error occurs whilst reading the file

RuntimeException - if an error occurs whilst lexing or parsing the file