Index (JPlag Language API 5.1.0 API)

A B C D E F G H I J K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractParser - Class in de.jplag: Abstract parser class.
AbstractParser() - Constructor for class de.jplag.AbstractParser
addAllNonLocalVariablesAsReads() - Method in class de.jplag.semantics.VariableRegistry: Add all non-local visible variables as reads to the current CodeSemantics instance.
addRead(Variable) - Method in class de.jplag.semantics.CodeSemantics: Add a variable to the set of variables which were (potentially) read from in this code snippet.
addWrite(Variable) - Method in class de.jplag.semantics.CodeSemantics: Add a variable to the set of variables which were (potentially) written to in this code snippet.

B

bidirectionalBlockDepthChange() - Method in class de.jplag.semantics.CodeSemantics
bool() - Static method in class de.jplag.options.OptionType

C

checkParentWritable(File) - Static method in class de.jplag.util.FileUtils: Checks if the parent file can be written to.
checkWritable(File) - Static method in class de.jplag.util.FileUtils: Checks if the given file can be written to.
CLASS - Enum constant in enum class de.jplag.semantics.VariableScope: The variable is only visible in the class it was declared in.
CodeSemantics - Class in de.jplag.semantics: Contains semantic information about a code snippet, in our case either a token or a statement.
CodeSemantics() - Constructor for class de.jplag.semantics.CodeSemantics: Creates new semantics with the following meaning: The code snippet may be removed, and its position relative to other code snippets may change.
column() - Method in record class de.jplag.TokenTrace: Returns the value of the column record component.
createControl() - Static method in class de.jplag.semantics.CodeSemantics
createCritical() - Static method in class de.jplag.semantics.CodeSemantics
createDefaultOption(OptionType<T>, String, String, T) - Method in class de.jplag.options.LanguageOptions: Creates a new option with default value.
createDefaultOption(OptionType<T>, String, T) - Method in class de.jplag.options.LanguageOptions: Creates a new option with default value and empty description.
createKeep() - Static method in class de.jplag.semantics.CodeSemantics
createLoopBegin() - Static method in class de.jplag.semantics.CodeSemantics
createLoopEnd() - Static method in class de.jplag.semantics.CodeSemantics
createOption(OptionType<T>, String) - Method in class de.jplag.options.LanguageOptions: Creates a new option with empty description
createOption(OptionType<T>, String, String) - Method in class de.jplag.options.LanguageOptions: Creates a new option
customizeSubmissionOrder(List<File>) - Method in interface de.jplag.Language: Re-orders the provided submission according the requirements of the language.

D

de.jplag - package de.jplag
de.jplag.options - package de.jplag.options
de.jplag.semantics - package de.jplag.semantics
de.jplag.util - package de.jplag.util
DefaultLanguageOption<T> - Class in de.jplag.options: Default implementation for LanguageOption
detectCharset(File) - Static method in class de.jplag.util.FileUtils: Detects the charset of a file.
detectCharsetFromMultiple(Collection<File>) - Static method in class de.jplag.util.FileUtils: Detects the most probable charset over the whole set of files.

E

EMPTY_OPTIONS - Static variable in class de.jplag.options.LanguageOptions
enterClass() - Method in class de.jplag.semantics.VariableRegistry: Enter a class.
enterLocalScope() - Method in class de.jplag.semantics.VariableRegistry: Enter a local scope.
equals(Object) - Method in record class de.jplag.TokenTrace: Indicates whether some other object is "equal to" this one.
exitClass() - Method in class de.jplag.semantics.VariableRegistry: Exit a class.
exitLocalScope() - Method in class de.jplag.semantics.VariableRegistry: Exit a local scope.
expectsSubmissionOrder() - Method in interface de.jplag.Language: Specifies if the submission order is relevant for this language.

F

FILE - Enum constant in enum class de.jplag.semantics.VariableScope: The variable is visible in the entire file.
FILE_END - Enum constant in enum class de.jplag.SharedTokenType: Marks the end of the file.
fileEnd(File) - Static method in class de.jplag.Token: Creates a token of type FILE_END without information about line, column, and length.
FileUtils - Class in de.jplag.util: Encapsulates various interactions with files to prevent issues with file encodings.

G

getColumn() - Method in class de.jplag.Token: Returns the character index which denotes where the code sections represented by this token starts in the line.
getDescription() - Method in class de.jplag.options.DefaultLanguageOption
getDescription() - Method in interface de.jplag.options.LanguageOption
getDescription() - Method in enum class de.jplag.SharedTokenType
getDescription() - Method in interface de.jplag.TokenType: Returns the user-readable description of this token type.
getFile() - Method in class de.jplag.Token
getIdentifier() - Method in interface de.jplag.Language: Identifier of the language used for CLI options and dynamic loading.
getJavaType() - Method in class de.jplag.options.OptionType
getLength() - Method in class de.jplag.Token: Gives the length if the code sections represented by this token.
getLine() - Method in class de.jplag.Token: Gives the line index denoting in which line the code sections represented by this token starts.
getName() - Method in interface de.jplag.Language: Descriptive name of the language.
getName() - Method in class de.jplag.options.DefaultLanguageOption
getName() - Method in interface de.jplag.options.LanguageOption
getNameAsUnixParameter() - Method in interface de.jplag.options.LanguageOption
getOptions() - Method in interface de.jplag.Language: Returns a new option object for the language.
getOptionsAsList() - Method in class de.jplag.options.LanguageOptions
getSemantics() - Method in class de.jplag.Token
getType() - Method in class de.jplag.options.DefaultLanguageOption
getType() - Method in interface de.jplag.options.LanguageOption
getType() - Method in class de.jplag.Token
getValue() - Method in class de.jplag.options.DefaultLanguageOption
getValue() - Method in interface de.jplag.options.LanguageOption

H

hasFullPositionSignificance() - Method in class de.jplag.semantics.CodeSemantics
hashCode() - Method in record class de.jplag.TokenTrace: Returns a hash code value for this object.
hasPartialPositionSignificance() - Method in class de.jplag.semantics.CodeSemantics
hasValue() - Method in class de.jplag.options.DefaultLanguageOption
hasValue() - Method in interface de.jplag.options.LanguageOption

I

inLocalScope() - Method in class de.jplag.semantics.VariableRegistry
integer() - Static method in class de.jplag.options.OptionType
isExcludedFromMatching() - Method in enum class de.jplag.SharedTokenType
isExcludedFromMatching() - Method in interface de.jplag.TokenType: Indicates that no matches containing this token type shall be generated.
isPreformatted() - Method in interface de.jplag.Language: Determines whether a fixed-width font should be used to display that language.

J

join(List<CodeSemantics>) - Static method in class de.jplag.semantics.CodeSemantics: Create new joint semantics by joining a number of existing ones.

K

keep() - Method in class de.jplag.semantics.CodeSemantics

L

Language - Interface in de.jplag: Common interface for all languages.
LanguageOption<T> - Interface in de.jplag.options: A single language specific option.
LanguageOptions - Class in de.jplag.options: Container for a languages options.
LanguageOptions() - Constructor for class de.jplag.options.LanguageOptions: New instance
length() - Method in record class de.jplag.TokenTrace: Returns the value of the length record component.
line() - Method in record class de.jplag.TokenTrace: Returns the value of the line record component.
LOCAL - Enum constant in enum class de.jplag.semantics.VariableScope: The variable is only visible in the local scope it was declared in.
logger - Variable in class de.jplag.AbstractParser

M

markFullPositionSignificance() - Method in class de.jplag.semantics.CodeSemantics: Mark this code snippet as having full position significance.
markKeep() - Method in class de.jplag.semantics.CodeSemantics: Mark this code snippet as having to be kept.
minimumTokenMatch() - Method in interface de.jplag.Language: Minimum number of tokens required for a match.

N

NO_VALUE - Static variable in class de.jplag.Token: Indicates that the requested field has no value.

O

openFileReader(File) - Static method in class de.jplag.util.FileUtils: Opens a file reader, guessing the charset from the content.
openFileWriter(File) - Static method in class de.jplag.util.FileUtils: Opens a file writer, using the default charset for JPlag
OptionType<T> - Class in de.jplag.options: The available types for language specific options.

P

parse(Set<File>) - Method in interface de.jplag.Language: Deprecated, for removal: This API element is subject to removal in a future version.
Replaced by Language.parse(Set, boolean)
parse(Set<File>, boolean) - Method in interface de.jplag.Language: Parses a set of files.
ParsingException - Exception Class in de.jplag: An exception to throw if any error occurred while parsing files in a language frontend.
ParsingException(File) - Constructor for exception class de.jplag.ParsingException: Constructs a new exception indicating a parsing exception in the given file without a specific reason.
ParsingException(File, String) - Constructor for exception class de.jplag.ParsingException: Constructs a new exception indicating a parsing exception in the given file with the given reason.
ParsingException(File, String, Throwable) - Constructor for exception class de.jplag.ParsingException: Constructs a new exception indicating a parsing exception in the given file with the given reason and cause.
ParsingException(File, Throwable) - Constructor for exception class de.jplag.ParsingException: Constructs a new exception indicating a parsing exception in the given file with the given cause.
printTokens(List<Token>) - Static method in class de.jplag.TokenPrinter: Creates a string representation of a set of files line by line and adds the tokens under the lines.
printTokens(List<Token>, File) - Static method in class de.jplag.TokenPrinter: Creates a string representation of a set of files line by line and adds the tokens under the lines.
printTokens(List<Token>, File, Optional<String>) - Static method in class de.jplag.TokenPrinter: Creates a string representation of a collection of files line by line and adds the tokens under the lines.

R

READ - Enum constant in enum class de.jplag.semantics.VariableAccessType: The variable is read from.
READ_WRITE - Enum constant in enum class de.jplag.semantics.VariableAccessType: The variable is read from and written to.
readFileContent(File) - Static method in class de.jplag.util.FileUtils: Reads the contents of a file into a single string.
reads() - Method in class de.jplag.semantics.CodeSemantics
registerVariable(String, VariableScope, boolean) - Method in class de.jplag.semantics.VariableRegistry: Register a variable.
registerVariableAccess(String, boolean) - Method in class de.jplag.semantics.VariableRegistry: Register a variable access, more precisely: Add a variable access to the current CodeSemantics instance.
requiresCoreNormalization() - Method in interface de.jplag.Language: Override this method, if you need normalization within the language module, but not in the core module.

S

semanticFileEnd(File) - Static method in class de.jplag.Token: Creates a token of type FILE_END without information about line, column, and length, but with semantic information.
setIgnoreNextVariableAccess(boolean) - Method in class de.jplag.semantics.VariableRegistry: Set whether the next variable access is ignored.
setMutableWrite(boolean) - Method in class de.jplag.semantics.VariableRegistry: Set whether accesses to mutable variables are writes from this point on.
setNextVariableAccessType(VariableAccessType) - Method in class de.jplag.semantics.VariableRegistry: Set the type of the next variable access.
setValue(T) - Method in class de.jplag.options.DefaultLanguageOption
setValue(T) - Method in interface de.jplag.options.LanguageOption: Updates the options value.
SharedTokenType - Enum Class in de.jplag: Shared token types that occur for any language.
string() - Static method in class de.jplag.options.OptionType
suffixes() - Method in interface de.jplag.Language: Suffixes for the files containing code of the language.
supportsNormalization() - Method in interface de.jplag.Language

T

Token - Class in de.jplag: This class represents a token in a source code.
Token(TokenType, File, int, int, int) - Constructor for class de.jplag.Token: Creates a token with column and length information.
Token(TokenType, File, int, int, int, CodeSemantics) - Constructor for class de.jplag.Token: Creates a token with column, length and semantic information.
Token(TokenType, File, TokenTrace) - Constructor for class de.jplag.Token: Creates a token with column and length information.
TokenPrinter - Class in de.jplag: Utility class for printing JPlag tokens from a submission.
tokensHaveSemantics() - Method in interface de.jplag.Language: Indicates whether the tokens returned by parse have semantic information added to them, i.e.
TokenTrace - Record Class in de.jplag: Tracing information to locate the corresponding code section of a token.
TokenTrace() - Constructor for record class de.jplag.TokenTrace: Creates a empty trace with line, column, and length set to NO_VALUE.
TokenTrace(int, int, int) - Constructor for record class de.jplag.TokenTrace: Creates an instance of a TokenTrace record class.
TokenType - Interface in de.jplag: Indicates the type of a token.
toString() - Method in class de.jplag.semantics.CodeSemantics
toString() - Method in class de.jplag.semantics.Variable
toString() - Method in class de.jplag.Token
toString() - Method in record class de.jplag.TokenTrace: Returns a string representation of this record class.

U

updateSemantics(CodeSemantics) - Method in class de.jplag.semantics.VariableRegistry: Update the current semantics.
useViewFiles() - Method in interface de.jplag.Language: Indicates whether the input files (code) should be used as representation in the report, or different files that form a view on the input files.

V

valueOf(String) - Static method in enum class de.jplag.semantics.VariableAccessType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class de.jplag.semantics.VariableScope: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class de.jplag.SharedTokenType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class de.jplag.semantics.VariableAccessType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class de.jplag.semantics.VariableScope: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class de.jplag.SharedTokenType: Returns an array containing the constants of this enum class, in the order they are declared.
Variable - Class in de.jplag.semantics: Each variable has its unique identity, important for tracing in graph (NormalizationGraph::spreadKeep).
VariableAccessType - Enum Class in de.jplag.semantics: The ways a variable can be accessed.
VariableRegistry - Class in de.jplag.semantics: Registry of variables to assist in generating token semantics.
VariableRegistry() - Constructor for class de.jplag.semantics.VariableRegistry: Initialize a new variable registry.
VariableScope - Enum Class in de.jplag.semantics: The scopes a variable can have.
viewFileSuffix() - Method in interface de.jplag.Language: If the language uses representation files, this method returns the suffix used for the representation files.

W

wrappingExceptions(Collection<ParsingException>) - Static method in exception class de.jplag.ParsingException: Creates a new parsing exception which wraps the provided exceptions.
write(File, String) - Static method in class de.jplag.util.FileUtils: Writes the given content into the given file using the default charset
WRITE - Enum constant in enum class de.jplag.semantics.VariableAccessType: The variable is written to.
writes() - Method in class de.jplag.semantics.CodeSemantics

A B C D E F G H I J K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form