Package org.harctoolbox.irp

Class ParameterSpecs

java.lang.Object

org.harctoolbox.irp.IrpObject

org.harctoolbox.irp.ParameterSpecs

All Implemented Interfaces:

Serializable, Iterable<ParameterSpec>, Comparator<String>, AggregateLister, XmlExport

public final class ParameterSpecs
extends IrpObject
implements Iterable<ParameterSpec>, AggregateLister, Comparator<String>

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ParameterSpecs()
ParameterSpecs(String parameter_specs)
ParameterSpecs(List<ParameterSpec> list)
ParameterSpecs(IrpParser.Parameter_specsContext ctx)
ParameterSpecs(IrpParser.ProtocolContext ctx)

Method Summary

Modifier and Type	Method	Description
void	addDefaulteds(Map<String,Long> params)
Long	bitmask(String name)
Map<String,Long>	bitmasks()
String	code(CodeGenerator codeGenerator)
int	compare(String first, String second)
boolean	equals(Object obj)
Set<String>	getNames()
Expression	getParameterDefault(String parameterName)
long	getParameterMax(String parameterName)
long	getParameterMin(String parameterName)
ParameterSpec	getParameterSpec(String name)
Collection<ParameterSpec>	getParams()
int	hashCode()
boolean	hasNonStandardParameters()
boolean	hasParameter(String name)
boolean	hasParameterDefault(String parameterName)
boolean	hasParameterMemory(String parameterName)
boolean	isEmpty()
Iterator<ParameterSpec>	iterator()
Map<String,Object>	propertiesMap(GeneralSpec generalSpec, NameEngine nameEngine)
Map<String,Long>	random()
Map<String,Long>	random(Random rng)
Map<String,Long>	randomUsingDefaults()
Map<String,Long>	randomUsingDefaults(Random rng)
void	removeDefaulteds(Map<String,Long> namesMap)
void	removeNotInParameterSpec(Map<String,Long> namesMap)
void	replace(ParameterSpecs newParameterSpecs)
int	size()
Map<String,Long>	sort(Map<String,Long> unsortedMap)
Element	toElement(Document document)
String	toIrpString(int radix)	Returns a computed IRP (-segment) string representation of current IrpObject.
String	toIrpString(int radix, String separator)
void	tweak(String name, long min, long max)
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.util.Comparator

reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

ParameterSpecs

public ParameterSpecs()

ParameterSpecs

public ParameterSpecs(String parameter_specs)

ParameterSpecs

public ParameterSpecs(IrpParser.ProtocolContext ctx)

ParameterSpecs

public ParameterSpecs(IrpParser.Parameter_specsContext ctx)

ParameterSpecs

public ParameterSpecs(List<ParameterSpec> list)

Method Details

compare

public int compare(String first,
 String second)

Specified by:

compare in interface Comparator<String>

sort

public Map<String,Long> sort(Map<String,Long> unsortedMap)

equals

public boolean equals(Object obj)

Specified by:

equals in interface Comparator<String>

Specified by:

equals in class IrpObject

replace

public void replace(ParameterSpecs newParameterSpecs)

hashCode

public int hashCode()

Specified by:

hashCode in class IrpObject

isEmpty

public boolean isEmpty()

getNames

public Set<String> getNames()

getParams

public Collection<ParameterSpec> getParams()

getParameterSpec

public ParameterSpec getParameterSpec(String name)

bitmask

public Long bitmask(String name)

bitmasks

public Map<String,Long> bitmasks()

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.

toIrpString

public String toIrpString(int radix,
 String separator)

toElement

public Element toElement(Document document)

Specified by:

toElement in interface XmlExport

Overrides:

toElement in class IrpObject

Parameters:

document -

Returns:

random

public Map<String,Long> random()

random

public Map<String,Long> random(Random rng)

randomUsingDefaults

public Map<String,Long> randomUsingDefaults()

randomUsingDefaults

public Map<String,Long> randomUsingDefaults(Random rng)

iterator

public Iterator<ParameterSpec> iterator()

Specified by:

iterator in interface Iterable<ParameterSpec>

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.

removeDefaulteds

public void removeDefaulteds(Map<String,Long> namesMap)

addDefaulteds

public void addDefaulteds(Map<String,Long> params)

removeNotInParameterSpec

public void removeNotInParameterSpec(Map<String,Long> namesMap)

code

public String code(CodeGenerator codeGenerator)

propertiesMap

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

Specified by:

propertiesMap in interface AggregateLister

hasParameter

public boolean hasParameter(String name)

hasParameterMemory

public boolean hasParameterMemory(String parameterName)

getParameterDefault

public Expression getParameterDefault(String parameterName)

hasParameterDefault

public boolean hasParameterDefault(String parameterName)

getParameterMax

public long getParameterMax(String parameterName)
                     throws NullPointerException

Throws:

NullPointerException

getParameterMin

public long getParameterMin(String parameterName)
                     throws NullPointerException

Throws:

NullPointerException

hasNonStandardParameters

public boolean hasNonStandardParameters()

size

public int size()

tweak

public void tweak(String name,
 long min,
 long max)
           throws InvalidNameException

Throws:

InvalidNameException