org.spongepowered.api.config

Annotation Type ConfigDir

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

Provides an convenient injection for ConfigRoot.getDirectory().

Use this annotation on a File or Path. 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, or instead, the plugin-specific configuration directory.

Element Detail

sharedRoot

public abstract boolean sharedRoot

Whether the the shared root for configuration should be used, or instead, the plugin-specific configuration directory.

Returns:

True to use a shared root configuration

See Also:

For information on what the shared root is