com.io7m.jpra.model.types

Class TString

java.lang.Object

com.io7m.jpra.model.types.TString

All Implemented Interfaces:

ModelElementType, TType

@Immutable
public final class TString
extends Object
implements TType

A string type expression.

Constructor Summary

Constructors

Constructor and Description
TString(Optional<com.io7m.jlexing.core.ImmutableLexicalPositionType<Path>> in_lex, String in_encoding, Size<SizeUnitOctetsType> in_size) Construct an expression.

Method Summary

Modifier and Type	Method and Description
String	getEncoding()
Optional<com.io7m.jlexing.core.ImmutableLexicalPositionType<Path>>	getLexicalInformation() Fetch the lexical information for the element.
Size<SizeUnitOctetsType>	getMaximumStringLength()
Size<SizeUnitBitsType>	getSizeInBits()
<A,E extends Exception> A	matchType(TypeMatcherType<A,E> m) Accept a matcher.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TString

public TString(Optional<com.io7m.jlexing.core.ImmutableLexicalPositionType<Path>> in_lex,
               String in_encoding,
               Size<SizeUnitOctetsType> in_size)

Construct an expression.

Parameters:

in_lex - Lexical information

in_encoding - The string encoding

in_size - An expression denoting the maximum size of the string in octets

Method Detail

getMaximumStringLength

public Size<SizeUnitOctetsType> getMaximumStringLength()

Returns:

The maximum length of the string in octets

getEncoding

public String getEncoding()

Returns:

The string encoding

getSizeInBits

public Size<SizeUnitBitsType> getSizeInBits()

Specified by:

getSizeInBits in interface TType

Returns:

The size in bits

matchType

public <A,E extends Exception> A matchType(TypeMatcherType<A,E> m)
                                    throws E extends Exception

Description copied from interface: TType

Accept a matcher.

Specified by:

matchType in interface TType

Type Parameters:

A - The type of returned values

E - The type of raised exceptions

Parameters:

m - The matcher

Returns:

The value returned by m

Throws:

E - If m raises E

E extends Exception

getLexicalInformation

public Optional<com.io7m.jlexing.core.ImmutableLexicalPositionType<Path>> getLexicalInformation()

Description copied from interface: ModelElementType

Fetch the lexical information for the element. This is used to localize error messages to a position in a file when referring to specific elements.

Specified by:

getLexicalInformation in interface ModelElementType

Returns:

The original lexical information, if any

toString

public String toString()

Overrides:

toString in class Object