Package dev.zemco.codegame.compilation.parsing

Class AbstractNamedParametrizedInstructionParser

java.lang.Object

dev.zemco.codegame.compilation.parsing.AbstractNamedParametrizedInstructionParser

All Implemented Interfaces:

IInstructionParser

Direct Known Subclasses:

FactorySingleParameterInstructionParser, SupplierInstructionParser

public abstract class AbstractNamedParametrizedInstructionParser
extends Object
implements IInstructionParser

Abstract base for instruction parsers parsing a single named instruction encoded with parameters separated by whitespace. First part of a raw instruction is treated as the instruction name.

Author:

Erik Zemčík

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractNamedParametrizedInstructionParser(String instructionName)	Initializes a subclass instance of AbstractNamedParametrizedInstructionParser that parses a parametrized instruction with the given name.

Method Summary

Modifier and Type	Method	Description
protected void	checkParameterFixedCount(String[] parameters, int parameterCount)	Checks if the given parameters have a required fixed count.
Optional<IInstruction>	parseInstruction(String rawInstruction)	Parses a single instruction encoded in a given string.
protected abstract Optional<IInstruction>	parseInstructionFromParameters(String[] parameters)	Parses the named instruction from its given parameters.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractNamedParametrizedInstructionParser

protected AbstractNamedParametrizedInstructionParser(String instructionName)

Initializes a subclass instance of AbstractNamedParametrizedInstructionParser that parses a parametrized instruction with the given name.

Parameters:

instructionName - name of the instruction to parse

Throws:

IllegalArgumentException - if instructionName is null

Method Details

parseInstructionFromParameters

protected abstract Optional<IInstruction> parseInstructionFromParameters(String[] parameters)

Parses the named instruction from its given parameters. This method may return an empty optional, if the parser does not support the given raw instruction.

Parameters:

parameters - raw instruction parameters

Returns:

parsed instruction or an empty optional

parseInstruction

public Optional<IInstruction> parseInstruction(String rawInstruction)

Description copied from interface: IInstructionParser

Parses a single instruction encoded in a given string. This method may return an empty optional, if the parser does not support the given raw instruction.

Specified by:

parseInstruction in interface IInstructionParser

Parameters:

rawInstruction - instruction encoded in a string

Returns:

parsed instruction or an empty optional

checkParameterFixedCount

protected void checkParameterFixedCount(String[] parameters,
 int parameterCount)

Checks if the given parameters have a required fixed count. This method is intended to be used by subclasses which require a fixed parameter count for their instruction parsing.

Parameters:

parameters - instruction parameters

parameterCount - expected fixed instruction parameter count

Throws:

IllegalArgumentException - if parameters is null or if parameterCount is not a positive integer

InstructionParseException - if the count of parameters does not match the requested parameterCount