Top Description Constructors Methods
org.eclipse.jgit.lib

public abstract Class StoredConfig

extends Config
Class Inheritance
Known Direct Subclasses
org.eclipse.jgit.storage.file.FileBasedConfig, org.eclipse.jgit.internal.storage.dfs.DfsConfig
Imports
java.io.IOException, org.eclipse.jgit.errors.ConfigInvalidException

Persistent configuration that can be stored and loaded from a location.

Constructor Summary

AccessConstructor and Description
public
StoredConfig()

Create a configuration with no default fallback.

public
StoredConfig(Config
the base configuration to be consulted when a key is missing from this configuration instance.
defaultConfig
)

Create an empty configuration with a fallback for missing keys.

Method Summary

Modifier and TypeMethod and Description
public void
clear()

Overrides org.eclipse.jgit.lib.Config.clear.

Clear the configuration file

public abstract void
load()

Load the configuration from the persistent store.

public abstract void
save()

Save the configuration to the persistent store.

Inherited from org.eclipse.jgit.lib.Config:
addChangeListenerescapeSubsectionescapeValuefireConfigChangedEventfromTextgetgetBaseConfiggetBooleangetBooleangetBooleangetBooleangetEnumgetEnumgetEnumgetIntgetIntgetIntgetIntgetIntInRangegetIntInRangegetIntInRangegetIntInRangegetLonggetLonggetLonggetLonggetNamesgetNamesgetNamesgetNamesgetPathgetRefSpecsgetSectionsgetStringgetStringListgetSubsectionsgetTimeUnitgetTimeUnitisMissingisUtf8notifyUponTransientChangesreadIncludedConfigremoveSectionsetBooleansetEnumsetIntsetLongsetStringsetStringListsetTypedConfigGettertoTextuncacheunsetunsetSection

Constructor Detail

StoredConfigback to summary
public StoredConfig()

Create a configuration with no default fallback.

StoredConfigback to summary
public StoredConfig(Config defaultConfig)

Create an empty configuration with a fallback for missing keys.

Parameters
defaultConfig:Config

the base configuration to be consulted when a key is missing from this configuration instance.

Method Detail

clearback to summary
public void clear()

Overrides org.eclipse.jgit.lib.Config.clear.

Doc from org.eclipse.jgit.lib.Config.clear.

Clear the configuration file

Annotations
@Override
loadback to summary
public abstract void load() throws IOException, ConfigInvalidException

Load the configuration from the persistent store.

If the configuration does not exist, this configuration is cleared, and thus behaves the same as though the backing store exists, but is empty.

Exceptions
IOException:
the configuration could not be read (but does exist).
ConfigInvalidException:
the configuration is not properly formatted.
saveback to summary
public abstract void save() throws IOException

Save the configuration to the persistent store.

Exceptions
IOException:
the configuration could not be written.