de.uka.ilkd.key.java.expression.literal

Class CharLiteral

java.lang.Object

de.uka.ilkd.key.java.JavaSourceElement

de.uka.ilkd.key.java.JavaProgramElement

de.uka.ilkd.key.java.expression.Literal

de.uka.ilkd.key.java.expression.literal.AbstractIntegerLiteral

de.uka.ilkd.key.java.expression.literal.CharLiteral

All Implemented Interfaces:

Expression, ModelElement, ProgramElement, SourceElement, TerminalProgramElement, SVSubstitute

public class CharLiteral
extends AbstractIntegerLiteral

Char literal.

Author:

Wolfram Pfeifer

Field Summary

Fields

Modifier and Type	Field and Description
private char	charVal The actual char this CharLiteral represents.

Constructor Summary

Constructors

Constructor and Description
CharLiteral(char charVal) Creates a new CharLiteral from the given char.
CharLiteral(ExtList children, java.lang.String valueStr) Creates a new CharLiteral from the given String.
CharLiteral(java.lang.String valueStr) Creates a new CharLiteral from the given String.

Method Summary

Modifier and Type	Method and Description
KeYJavaType	getKeYJavaType(Services javaServ) retrieves the literal's type
long	getValue() Returns the decimal value of the char.
java.lang.String	getValueString()
protected char	parseFromString(java.lang.String sourceStr) Parses the String and extracts the actual value of the literal.
void	prettyPrint(PrettyPrinter p) Pretty printing the source element.
java.lang.String	toString() toString
void	visit(Visitor v) calls the corresponding method of a visitor in order to perform some action/transformation on this element

Methods inherited from class de.uka.ilkd.key.java.expression.literal.AbstractIntegerLiteral

computeHashCode, equals, equalsModRenaming, getLDTName, representsDecLiteral

Methods inherited from class de.uka.ilkd.key.java.expression.Literal

getKeYJavaType, match

Methods inherited from class de.uka.ilkd.key.java.JavaProgramElement

getComments, hashCode, prettyPrintMain, reuseSignature

Methods inherited from class de.uka.ilkd.key.java.JavaSourceElement

getEndPosition, getFirstElement, getFirstElementIncludingBlocks, getLastElement, getParentClass, getPositionInfo, getRelativePosition, getStartPosition, setParentClass, toSource, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.uka.ilkd.key.java.ProgramElement

getComments

Methods inherited from interface de.uka.ilkd.key.java.SourceElement

getEndPosition, getFirstElement, getFirstElementIncludingBlocks, getLastElement, getPositionInfo, getRelativePosition, getStartPosition

Field Detail

charVal

private final char charVal

The actual char this CharLiteral represents.

Constructor Detail

CharLiteral

public CharLiteral(char charVal)

Creates a new CharLiteral from the given char.

Parameters:

charVal - a char value.

CharLiteral

public CharLiteral(ExtList children,
                   java.lang.String valueStr)

Creates a new CharLiteral from the given String. Char literals can be given as described in the Java 8 Language Specification: chars written directly (like 'a', '0', 'Z'), Java escape chars (like '\n', '\r'), and octal Unicode escapes (like '\040'). Note that unicode escapes in hexadecimal form are processed earlier and don't have to be handled here. Note that the char must be enclosed in single-quotes.

Parameters:

children - an ExtList with all children(comments). May contain: Comments

valueStr - a string.

CharLiteral

public CharLiteral(java.lang.String valueStr)

Creates a new CharLiteral from the given String. The String must be of the form 'c' (with c being an arbitrary char).

Parameters:

valueStr - a string.

Method Detail

getValue

public long getValue()

Returns the decimal value of the char.

Specified by:

getValue in class AbstractIntegerLiteral

Returns:

the decimal value of the char as a BigInteger

visit

public void visit(Visitor v)

Description copied from interface: SourceElement

calls the corresponding method of a visitor in order to perform some action/transformation on this element

Parameters:

v - the Visitor

prettyPrint

public void prettyPrint(PrettyPrinter p)
                 throws java.io.IOException

Description copied from class: JavaSourceElement

Pretty printing the source element.

Specified by:

prettyPrint in interface SourceElement

Overrides:

prettyPrint in class JavaProgramElement

Parameters:

p - a pretty printer.

Throws:

java.io.IOException - occasionally thrown.

getKeYJavaType

public KeYJavaType getKeYJavaType(Services javaServ)

Description copied from class: Literal

retrieves the literal's type

Specified by:

getKeYJavaType in class Literal

Parameters:

javaServ - the Services offering access to the Java model

Returns:

the literal's type

toString

public java.lang.String toString()

Description copied from class: JavaSourceElement

toString

Overrides:

toString in class AbstractIntegerLiteral

getValueString

public java.lang.String getValueString()

Specified by:

getValueString in class AbstractIntegerLiteral

Returns:

the actual value of the literal converted to a decimal String. If the literal represents a negative value, the first character is a '-' sign.

parseFromString

protected char parseFromString(java.lang.String sourceStr)

Parses the String and extracts the actual value of the literal. This method is able to parse char literals as described in the Java 8 Language Specification: chars written directly (like 'a', '0', 'Z'), Java escape chars (like '\n', '\r'), and octal Unicode escapes (like '\040'). Note that unicode escapes in hexadecimal form are processed earlier and don't have to be handled by this method. This method does not check the length of the literal for validity.

Parameters:

sourceStr - the String containing the literal surrounded by single-quotes

Returns:

the parsed value as a char

Throws:

java.lang.NumberFormatException - if the given String does not represent a syntactically valid character literal or the literal is not surrounded by single-quotes

See Also:

https://docs.oracle.com/javase/specs/jls/se8/html/jls-3.html#jls-3.10.4