org.spongepowered.api.config

Annotation Type DefaultConfig

@Retention(value=RUNTIME)
 @Target(value={PARAMETER,FIELD})
public @interface DefaultConfig

Provides an convenient injection for ConfigRoot.getConfig() or ConfigRoot.getConfigPath().

Use this annotation on a File or Path if you want the pathname to the default configuration. Or instead, use this annotation on a ConfigurationLoader to get an instance of that. Remember that Inject is also necessary.

See Also:

For getting configuration without injection

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
boolean	sharedRoot Whether the the shared root for configuration should be used.

Element Detail

sharedRoot

public abstract boolean sharedRoot

Whether the the shared root for configuration should be used.

Returns:

True to use a shared root configuration

See Also:

For information on what the shared root is