Package org.harctoolbox.irp

Class NameEngine

java.lang.Object

org.harctoolbox.irp.IrpObject

org.harctoolbox.irp.NameEngine

All Implemented Interfaces:

Serializable, Iterable<Map.Entry<String,Expression>>, AggregateLister, XmlExport

public final class NameEngine
extends IrpObject
implements AggregateLister, Iterable<Map.Entry<String,Expression>>

Implementation of Definitions in Chapter 10 and Assignments in Chapter 11; these are not independent objects.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final NameEngine	EMPTY

Constructor Summary

Constructors

Constructor	Description
NameEngine()
NameEngine(int initialCapacity)
NameEngine(String str)
NameEngine(Map<String,Long> numericalParameters)
NameEngine(NameEngine orig)

Method Summary

Modifier and Type	Method	Description
boolean	containsKey(String name)
void	define(String name, Number value)
void	define(String name, Expression expression)
boolean	equals(Object obj)
Expression	get(String name)	Returns the expression associated to the name given as parameter.
Expression	get(Name name)
Set<String>	getNames()
Expression	getPossiblyNull(String name)
int	hashCode()
boolean	isEmpty()
Iterator<Map.Entry<String,Expression>>	iterator()
boolean	numericallyEquals(Object object)
boolean	numericallyEquals(Map<String,Long> other)
boolean	numericallyEquals(Decoder.Decode other)
boolean	numericallyEquals(NameEngine other)
static NameEngine	parse(String[] definitions)
void	parseDefinitions(String str)	Invoke the parser on the supplied argument, and stuff the result into the name engine.
void	parseDefinitions(IrpParser.DefinitionsContext ctx)
static NameEngine	parseLoose(String str)
Map<String,Object>	propertiesMap(GeneralSpec generalSpec, NameEngine nameEngine)
int	size()
Element	toElement(Document document)
String	toIrpString(int radix)	Returns a computed IRP (-segment) string representation of current IrpObject.
long	toLong(String name)
Map<String,Long>	toMap()
int	weight()	Returns a (somewhat arbitrary) measure of the complexity of the object.

Methods inherited from class org.harctoolbox.irp.IrpObject

createParameterSpecs, getParseTree, numberOfBits, numberOfBitSpecs, numberOfInfiniteRepeats, prerender, propertiesMap, toDocument, toIrpString, toString, toString, toStringTree, toStringTree, toTreeViewer, toTreeViewer, toTreeViewer, updateStateWhenEntering, updateStateWhenExiting

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

EMPTY

public static final NameEngine EMPTY

Constructor Details

NameEngine

public NameEngine(Map<String,Long> numericalParameters)

NameEngine

public NameEngine()

NameEngine

public NameEngine(int initialCapacity)

NameEngine

public NameEngine(String str)
           throws InvalidNameException

Throws:

InvalidNameException

NameEngine

public NameEngine(NameEngine orig)

Method Details

parseLoose

public static NameEngine parseLoose(String str)

parse

public static NameEngine parse(String[] definitions)

hashCode

public int hashCode()

Specified by:

hashCode in class IrpObject

equals

public boolean equals(Object obj)

Specified by:

equals in class IrpObject

size

public int size()

numericallyEquals

public boolean numericallyEquals(Object object)

numericallyEquals

public boolean numericallyEquals(Map<String,Long> other)

numericallyEquals

public boolean numericallyEquals(NameEngine other)

numericallyEquals

public boolean numericallyEquals(Decoder.Decode other)

iterator

public Iterator<Map.Entry<String,Expression>> iterator()

Specified by:

iterator in interface Iterable<Map.Entry<String,Expression>>

define

public void define(String name,
 Expression expression)
            throws InvalidNameException

Throws:

InvalidNameException

define

public void define(String name,
 Number value)
            throws InvalidNameException

Throws:

InvalidNameException

parseDefinitions

public void parseDefinitions(String str)

Invoke the parser on the supplied argument, and stuff the result into the name engine.

Parameters:

str - String to be parsed, like "{C = F*4 + D + 3}".

parseDefinitions

public void parseDefinitions(IrpParser.DefinitionsContext ctx)

get

public Expression get(String name)
               throws NameUnassignedException

Returns the expression associated to the name given as parameter.

Parameters:

name -

Returns:

Throws:

NameUnassignedException

get

public Expression get(Name name)
               throws NameUnassignedException

Throws:

NameUnassignedException

getPossiblyNull

public Expression getPossiblyNull(String name)

toLong

public long toLong(String name)
            throws NameUnassignedException

Throws:

NameUnassignedException

containsKey

public boolean containsKey(String name)

toIrpString

public String toIrpString(int radix)

Description copied from class: IrpObject

Returns a computed IRP (-segment) string representation of current IrpObject. Numerical parameters, but not durations etc, will be printed using the radix in the argument.

Specified by:

toIrpString in class IrpObject

Parameters:

radix - Radix for parameters.

Returns:

Formatted string.

toElement

public Element toElement(Document document)

Specified by:

toElement in interface XmlExport

Overrides:

toElement in class IrpObject

Parameters:

document -

Returns:

getNames

public Set<String> getNames()

toMap

public Map<String,Long> toMap()

isEmpty

public boolean isEmpty()

weight

public int weight()

Description copied from class: IrpObject

Returns a (somewhat arbitrary) measure of the complexity of the object. Can be used for determining if a decode is "simpler" than another decode.

Specified by:

weight in class IrpObject

Returns:

non-negative integer.

propertiesMap

public Map<String,Object> propertiesMap(GeneralSpec generalSpec,
 NameEngine nameEngine)

Specified by:

propertiesMap in interface AggregateLister