com.helger.photon.basic.configfile

Class ConfigurationFile

java.lang.Object

com.helger.photon.basic.configfile.ConfigurationFile

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, com.helger.commons.text.IHasDescription

@NotThreadSafe
public class ConfigurationFile
extends Object
implements com.helger.commons.id.IHasID<String>, com.helger.commons.text.IHasDescription

Constructor Summary

Constructors

Constructor and Description
ConfigurationFile(com.helger.commons.io.resource.IReadableResource aRes) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	exists()
String	getContentAsString()
String	getContentAsString(Charset aCharset)
Charset	getDefaultCharset()
String	getDescription()
String	getID()
com.helger.commons.io.resource.IReadableResource	getResource()
EConfigurationFileSyntax	getSyntaxHighlightLanguage()
ConfigurationFile	setDefaultCharset(Charset aDefaultCharset)
ConfigurationFile	setDescription(String sDescription) Set the description to use.
ConfigurationFile	setSyntaxHighlightLanguage(EConfigurationFileSyntax eSyntaxHighlightLanguage)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.id.IHasID

getComparatorID

Methods inherited from interface com.helger.commons.text.IHasDescription

hasDescription

Constructor Detail

ConfigurationFile

public ConfigurationFile(@Nonnull
                         com.helger.commons.io.resource.IReadableResource aRes)

Constructor

Parameters:

aRes - The resource that points to the relevant configuration file.

Method Detail

getID

@Nonnull
public String getID()

Specified by:

getID in interface com.helger.commons.id.IHasID<String>

getResource

@Nonnull
public com.helger.commons.io.resource.IReadableResource getResource()

exists

public boolean exists()

getContentAsString

@Nullable
public String getContentAsString()

getContentAsString

@Nullable
public String getContentAsString(@Nonnull
                                            Charset aCharset)

getDescription

@Nullable
public String getDescription()

Specified by:

getDescription in interface com.helger.commons.text.IHasDescription

Returns:

The optional description of this configuration file. May be null.

setDescription

@Nonnull
public ConfigurationFile setDescription(@Nullable
                                                  String sDescription)

Set the description to use.

Parameters:

sDescription - The description for this configuration file. May be null.

Returns:

this

getDefaultCharset

@Nonnull
public Charset getDefaultCharset()

setDefaultCharset

@Nonnull
public ConfigurationFile setDefaultCharset(@Nonnull
                                                     Charset aDefaultCharset)

getSyntaxHighlightLanguage

@Nonnull
public EConfigurationFileSyntax getSyntaxHighlightLanguage()

setSyntaxHighlightLanguage

@Nonnull
public ConfigurationFile setSyntaxHighlightLanguage(@Nonnull
                                                              EConfigurationFileSyntax eSyntaxHighlightLanguage)

toString

public String toString()

Overrides:

toString in class Object