Module org.mal_lang.langspec

Package org.mal_lang.langspec.io

Class LangReader

java.lang.Object

org.mal_lang.langspec.io.LangReader

All Implemented Interfaces:

Closeable, AutoCloseable

public final class LangReader
extends Object
implements Closeable

Reads .mar files into Lang objects.

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
LangReader(InputStream in)	Constructs a new LangReader object.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this stream and releases any system resources associated with it.
Lang	read()	Returns a Lang object that is represented in the input source.
Lang	read(boolean readIcons, boolean readLicense)	Returns a Lang object that is represented in the input source.

Methods inherited from class java.lang.Object

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

Constructor Detail

LangReader

public LangReader(InputStream in)

Constructs a new LangReader object.

Parameters:

in - an input stream from which a .mar file is to be read

Throws:

NullPointerException - if in is null

Since:

1.0.0

Method Detail

read

public Lang read()
          throws IOException

Returns a Lang object that is represented in the input source. This method needs to be called only once for a reader instance.

Returns:

a Lang object

Throws:

IOException - if an I/O error occurs

IllegalStateException - if read or close method is already called

Since:

1.0.0

read

public Lang read(boolean readIcons,
                 boolean readLicense)
          throws IOException

Returns a Lang object that is represented in the input source. This method needs to be called only once for a reader instance.

Parameters:

readIcons - whether icons should be read

readLicense - whether license and notice should be read

Returns:

a Lang object

Throws:

IOException - if an I/O error occurs

IllegalStateException - if read or close method is already called

Since:

1.0.0

close

public void close()
           throws IOException

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - if an I/O error occurs

Since:

1.0.0