Package org.checkerframework.afu.scenelib.io

Class IndexFileParser

java.lang.Object

org.checkerframework.afu.scenelib.io.IndexFileParser

public final class IndexFileParser
extends Object

IndexFileParser provides static methods parse(LineNumberReader, String, AScene), parseFile(String, AScene), and parseString(String, String, AScene). Each of these parses an index file into a AScene.

If there are any problems, it throws a ParseException internally, or a FileIOException externally.

Method Summary

Modifier and Type	Method	Description
void	addDef(AnnotationDef ad)
void	addDef(AnnotationDef ad, String basename)
static Map<String,AnnotationDef>	parse(LineNumberReader in, String filename, AScene scene)	Reads annotations from in in index file format and merges them into scene.
static Map<String,AnnotationDef>	parseFile(String filename, AScene scene)	Reads annotations from the index file filename and merges them into scene; see parse(LineNumberReader, String, AScene).
static Map<String,AnnotationDef>	parseString(String fileContents, String source, AScene scene)	Reads annotations from the string (in index file format) and merges them into scene; see parse(LineNumberReader, String, AScene).
static Type	parseType(String text, String filename)	Parse the given text into a Type.
static void	setAbbreviate(boolean b)

Methods inherited from class java.lang.Object

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

Method Details

setAbbreviate

public static void setAbbreviate(boolean b)

addDef

public void addDef(AnnotationDef ad)
            throws ParseException

Throws:

ParseException

addDef

public void addDef(AnnotationDef ad,
 String basename)
            throws ParseException

Throws:

ParseException

parse

public static Map<String,AnnotationDef> parse(LineNumberReader in,
 String filename,
 AScene scene)
                                       throws IOException,
ParseException

Reads annotations from in in index file format and merges them into scene. Annotations from the input are merged into the scene; it is an error if both the scene and the input contain annotations of the same type on the same element.

Since each annotation in a scene carries its own definition and the scene as a whole no longer has a set of definitions, annotation definitions that are given in the input but never used are not saved anywhere and will not be included if the scene is written back to an index file. Similarly, retention policies on definitions of annotations that are never used at the top level are dropped.

Caveat: Parsing of floating point numbers currently does not work.

Throws:

IOException

ParseException

parseFile

public static Map<String,AnnotationDef> parseFile(String filename,
 AScene scene)
                                           throws IOException

Reads annotations from the index file filename and merges them into scene; see parse(LineNumberReader, String, AScene).

Throws:

IOException

parseString

public static Map<String,AnnotationDef> parseString(String fileContents,
 String source,
 AScene scene)
                                             throws IOException

Reads annotations from the string (in index file format) and merges them into scene; see parse(LineNumberReader, String, AScene). Primarily for testing.

Throws:

IOException

parseType

public static Type parseType(String text,
 String filename)

Parse the given text into a Type.

Parameters:

text - the text to parse

Returns:

the type