Package org.jabylon.properties.types.impl

Class PropertiesHelper

java.lang.Object

org.jabylon.properties.types.impl.PropertiesHelper

All Implemented Interfaces:

PropertyConverter

public class PropertiesHelper
extends Object
implements PropertyConverter

Author:

joe

Constructor Summary

Constructors

Constructor	Description
PropertiesHelper()
PropertiesHelper(boolean unicodeEscaping)
PropertiesHelper(boolean unicodeEscaping, org.eclipse.emf.common.util.URI uri)

Method Summary

Modifier and Type	Method	Description
static org.eclipse.emf.ecore.resource.ContentHandler.ByteOrderMark	checkForBom(InputStream inputStream)	returns the BOM if available.
protected String	deriveEncoding(org.eclipse.emf.ecore.resource.ContentHandler.ByteOrderMark bom)
String	getLicenseHeader()
protected boolean	isComment(String line)
protected boolean	isFilled(Property property)
boolean	isUnicodeEscaping()
PropertyFile	load(InputStream in, String encoding)	loads the given input stream and transform it into a PropertyFile
protected String	parseComment(String line)	extracts the comment from the given line
Property	readProperty(BufferedReader reader)
protected String[]	split(String propertyValue)	splits the property line into a key and value part
int	write(OutputStream out, PropertyFile file, String encoding)	serializes the given PropertyFile into the output steam
protected void	writeComment(Writer writer, String comment)
protected void	writeCommentAndAnnotations(Writer writer, Property property)
void	writeLicenseHeader(Writer writer, String licenseHeader)
void	writeProperty(Writer writer, Property property)

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertiesHelper

public PropertiesHelper()

PropertiesHelper

public PropertiesHelper(boolean unicodeEscaping)

PropertiesHelper

public PropertiesHelper(boolean unicodeEscaping,
                        org.eclipse.emf.common.util.URI uri)

Parameters:

unicodeEscaping -

uri - can be used to log the path of invalid files if supplied

Method Detail

readProperty

public Property readProperty(BufferedReader reader)
                      throws IOException

Throws:

IOException

parseComment

protected String parseComment(String line)

extracts the comment from the given line

Parameters:

line -

Returns:

the comment content

split

protected String[] split(String propertyValue)

splits the property line into a key and value part

Parameters:

propertyValue -

Returns:

isComment

protected boolean isComment(String line)

writeProperty

public void writeProperty(Writer writer,
                          Property property)
                   throws IOException

Throws:

IOException

writeCommentAndAnnotations

protected void writeCommentAndAnnotations(Writer writer,
                                          Property property)
                                   throws IOException

Throws:

IOException

writeComment

protected void writeComment(Writer writer,
                            String comment)
                     throws IOException

Throws:

IOException

checkForBom

public static org.eclipse.emf.ecore.resource.ContentHandler.ByteOrderMark checkForBom(InputStream inputStream)
                                                                               throws IOException

returns the BOM if available. If no BOM was found the stream is reset to its original state

Parameters:

inputStream - must support mark/rest, or an IllegalArgumentException is thrown

Returns:

Throws:

IOException

getLicenseHeader

public String getLicenseHeader()

writeLicenseHeader

public void writeLicenseHeader(Writer writer,
                               String licenseHeader)
                        throws IOException

Throws:

IOException

write

public int write(OutputStream out,
                 PropertyFile file,
                 String encoding)
          throws IOException

Description copied from interface: PropertyConverter

serializes the given PropertyFile into the output steam

The implementation is expected to close the stream upon completion

The implementation is free to optimize the output by removing empty translations.

Specified by:

write in interface PropertyConverter

encoding - hint about which encoding to use

Returns:

number of translated (non-empty) keys

Throws:

IOException

isFilled

protected boolean isFilled(Property property)

load

public PropertyFile load(InputStream in,
                         String encoding)
                  throws IOException

Description copied from interface: PropertyConverter

loads the given input stream and transform it into a PropertyFile

The implementation is expected to close the stream upon completion

Specified by:

load in interface PropertyConverter

encoding - hint about which encoding to use

Returns:

Throws:

IOException

deriveEncoding

protected String deriveEncoding(org.eclipse.emf.ecore.resource.ContentHandler.ByteOrderMark bom)

isUnicodeEscaping

public boolean isUnicodeEscaping()