com.aptana.ide.ui.editors.preferences.formatter
Class ProfileStore

java.lang.Object
  com.aptana.ide.ui.editors.preferences.formatter.ProfileStore

Direct Known Subclasses:

FormatterProfileStore

public class ProfileStore
extends java.lang.Object

Can load/store profiles from/to profilesKey

Field Summary

static java.lang.String	ENCODING The default encoding to use
protected static java.lang.String	VERSION_KEY_SUFFIX

Constructor Summary

ProfileStore(java.lang.String profilesKey, java.lang.String pluginId)

Method Summary

java.util.List	readProfiles(org.eclipse.core.runtime.preferences.IScopeContext scope)
java.util.List	readProfilesFromFile(java.io.File file) Read the available profiles from the internal XML file and return them as collection or null if the file is not a profile file.
static java.util.List	readProfilesFromStream(org.xml.sax.InputSource inputSource) Load profiles from a XML stream and add them to a map or null if the source is not a profile store.
java.util.List	readProfilesFromString(java.lang.String profiles)
void	writeProfiles(java.util.Collection profiles, org.eclipse.core.runtime.preferences.IScopeContext instanceScope)
void	writeProfilesToFile(java.util.Collection profiles, java.io.File file, java.lang.String encoding) Write the available profiles to the internal XML file.
static void	writeProfilesToStream(java.util.Collection profiles, java.io.OutputStream stream, java.lang.String encoding) Save profiles to an XML stream

Methods inherited from class java.lang.Object

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

Field Detail

ENCODING

public static final java.lang.String ENCODING

The default encoding to use

See Also:

Constant Field Values

VERSION_KEY_SUFFIX

protected static final java.lang.String VERSION_KEY_SUFFIX

See Also:

Constant Field Values

Constructor Detail

ProfileStore

public ProfileStore(java.lang.String profilesKey,
                    java.lang.String pluginId)

Parameters:

profilesKey -

pluginId -

Method Detail

readProfiles

public java.util.List readProfiles(org.eclipse.core.runtime.preferences.IScopeContext scope)
                            throws org.eclipse.core.runtime.CoreException

Parameters:

scope -

Returns:

Returns the collection of profiles currently stored in the preference store or null if the loading failed. The elements are of type ProfileManager.CustomProfile and are all updated to the latest version.

Throws:

org.eclipse.core.runtime.CoreException

writeProfiles

public void writeProfiles(java.util.Collection profiles,
                          org.eclipse.core.runtime.preferences.IScopeContext instanceScope)
                   throws org.eclipse.core.runtime.CoreException

Parameters:

profiles -

instanceScope -

Throws:

org.eclipse.core.runtime.CoreException

readProfilesFromString

public java.util.List readProfilesFromString(java.lang.String profiles)
                                      throws org.eclipse.core.runtime.CoreException

Parameters:

profiles -

Returns:

List

Throws:

org.eclipse.core.runtime.CoreException

readProfilesFromFile

public java.util.List readProfilesFromFile(java.io.File file)
                                    throws org.eclipse.core.runtime.CoreException

Read the available profiles from the internal XML file and return them as collection or null if the file is not a profile file.

Parameters:

file - The file to read from

Returns:

returns a list of CustomProfile or null

Throws:

org.eclipse.core.runtime.CoreException

readProfilesFromStream

public static java.util.List readProfilesFromStream(org.xml.sax.InputSource inputSource)
                                             throws org.eclipse.core.runtime.CoreException

Load profiles from a XML stream and add them to a map or null if the source is not a profile store.

Parameters:

inputSource - The input stream

Returns:

returns a list of CustomProfile or null

Throws:

org.eclipse.core.runtime.CoreException

writeProfilesToFile

public void writeProfilesToFile(java.util.Collection profiles,
                                java.io.File file,
                                java.lang.String encoding)
                         throws org.eclipse.core.runtime.CoreException

Write the available profiles to the internal XML file.

Parameters:

profiles - List of CustomProfile

file - File to write

encoding - the encoding to use

Throws:

org.eclipse.core.runtime.CoreException

writeProfilesToStream

public static void writeProfilesToStream(java.util.Collection profiles,
                                         java.io.OutputStream stream,
                                         java.lang.String encoding)
                                  throws org.eclipse.core.runtime.CoreException

Save profiles to an XML stream

Parameters:

profiles - the list of CustomProfile

stream - the stream to write to

encoding - the encoding to use

Throws:

org.eclipse.core.runtime.CoreException