SubjectData (SpongeAPI 7.4.0 API)

All Known Implementing Classes:

MemorySubjectData
```
public interface SubjectData
```
Container for a subject's data.
This container updates live, and provides raw data for a subject not taking into account any sort of inheritance. This interface is meant to represent what's 'in the file', rather than the higher-level query methods available in Subject.

Methods which modify the state of the data return CompletableFutures. This allows for the time which is taken to apply and persist the change to the implementations storage backend. These futures should return quickly for changes made to transient subject data, but may take longer to return for changes made to a subjects persistent data. Methods which use this data in Subject may not reflect the change until the future has returned.

CompletableFuture.allOf(CompletableFuture[]) can be used to combine multiple futures into one, if the result of methods is not needed.

Field Summary

Fields
Modifier and Type	Field and Description
`static Set<Context>`	`GLOBAL_CONTEXT` A convenience constant for the global context combination (the empty set), if you want your code to look especially fancy.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CompletableFuture<Boolean>`	`addParent(Set<Context> contexts, SubjectReference parent)` Adds a parent in a particular context combination.
`CompletableFuture<Boolean>`	`clearOptions()` Clear all options.
`CompletableFuture<Boolean>`	`clearOptions(Set<Context> contexts)` Clear all options in the given context combination.
`CompletableFuture<Boolean>`	`clearParents()` Remove all parents in any context combination.
`CompletableFuture<Boolean>`	`clearParents(Set<Context> contexts)` Remove all parents in a given context combination.
`CompletableFuture<Boolean>`	`clearPermissions()` Clear all permissions set in any context.
`CompletableFuture<Boolean>`	`clearPermissions(Set<Context> contexts)` Clear all permissions set in a given context combination.
`Map<Set<Context>,Map<String,String>>`	`getAllOptions()` Return all options for all context combinations currently registered.
`Map<Set<Context>,List<SubjectReference>>`	`getAllParents()` Return all registered parent subjects for all contexts.
`Map<Set<Context>,Map<String,Boolean>>`	`getAllPermissions()` Return all permissions associated with this data object.
`Map<String,String>`	`getOptions(Set<Context> contexts)` Gets options for a specific context combination.
`List<SubjectReference>`	`getParents(Set<Context> contexts)` Return all registered parent subjects for a given context.
`Map<String,Boolean>`	`getPermissions(Set<Context> contexts)` Returns the list of permissions set for the given context.
`CompletableFuture<Boolean>`	`removeParent(Set<Context> contexts, SubjectReference parent)` Removes a parent in a particular context combination.
`CompletableFuture<Boolean>`	`setOption(Set<Context> contexts, String key, String value)` Sets a specific option to a value.
`CompletableFuture<Boolean>`	`setPermission(Set<Context> contexts, String permission, Tristate value)` Sets a permission to a given value.

- Field Detail
  - GLOBAL_CONTEXT
```
static final Set<Context> GLOBAL_CONTEXT
```
    A convenience constant for the global context combination (the empty set), if you want your code to look especially fancy.
- Method Detail
  - getAllPermissions
```
Map<Set<Context>,Map<String,Boolean>> getAllPermissions()
```
    Return all permissions associated with this data object.
    
    Returns:
    
    an immutable copy of the mappings between contexts and lists of permissions containing every permission registered
  - getPermissions
```
Map<String,Boolean> getPermissions(Set<Context> contexts)
```
    Returns the list of permissions set for the given context.
    This list is immutable and is not a live view. If no permissions have been set, it returns an empty list.
    
    Parameters:
    
    contexts - The particular context combination to check
    
    Returns:
    
    Any permissions set
  - setPermission
```
CompletableFuture<Boolean> setPermission(Set<Context> contexts,
                                         String permission,
                                         Tristate value)
```
    Sets a permission to a given value.
    Setting value as Tristate.UNDEFINED unsets the permission.
    
    An empty set of contexts applies this permission to the global context.
    
    Parameters:
    
    contexts - The particular combination of contexts to set this permission in
    
    permission - The permission to set
    
    value - The value to set this permission to
    
    Returns:
    
    Whether the operation was successful
  - clearPermissions
```
CompletableFuture<Boolean> clearPermissions()
```
    Clear all permissions set in any context.
    
    Returns:
    
    Whether any change occurred
  - clearPermissions
```
CompletableFuture<Boolean> clearPermissions(Set<Context> contexts)
```
    Clear all permissions set in a given context combination.
    Passing an empty context set clears permissions in the global context.
    
    Parameters:
    
    contexts - The context combination to clear permissions in
    
    Returns:
    
    Whether any change occurred
  - getAllParents
```
Map<Set<Context>,List<SubjectReference>> getAllParents()
```
    Return all registered parent subjects for all contexts.
    The returned map is immutable and not a live view. The results of this method do not traverse any sort of inheritance structure a permissions plugin may implement.
    
    Returns:
    
    All registered parents and the context they are registered in
  - getParents
```
List<SubjectReference> getParents(Set<Context> contexts)
```
    Return all registered parent subjects for a given context.
    The returned map is immutable and not a live view. The results of this method do not traverse any sort of inheritance structure a permissions plugin may implement.
    
    Parameters:
    
    contexts - The context to check
    
    Returns:
    
    names of parents valid in the given context
  - addParent
```
CompletableFuture<Boolean> addParent(Set<Context> contexts,
                                     SubjectReference parent)
```
    Adds a parent in a particular context combination.
    Passing an empty context combination means the parent is added in the global context.
    
    Parameters:
    
    contexts - The context combination this operation is applicable to
    
    parent - The name of the parent to add
    
    Returns:
    
    Whether the operation was successful
  - removeParent
```
CompletableFuture<Boolean> removeParent(Set<Context> contexts,
                                        SubjectReference parent)
```
    Removes a parent in a particular context combination.
    Passing an empty context combination means the parent is removed in the global context.
    
    Parameters:
    
    contexts - The context combination this operation is applicable to
    
    parent - The name of the parent to remove
    
    Returns:
    
    Whether the operation was successful
  - clearParents
```
CompletableFuture<Boolean> clearParents()
```
    Remove all parents in any context combination.
    
    Returns:
    
    Whether any change occurred
  - clearParents
```
CompletableFuture<Boolean> clearParents(Set<Context> contexts)
```
    Remove all parents in a given context combination.
    Passing an empty context set clears parents in the global context.
    
    Parameters:
    
    contexts - The context combination to clear the parents of
    
    Returns:
    
    Whether any change occurred
  - getAllOptions
```
Map<Set<Context>,Map<String,String>> getAllOptions()
```
    Return all options for all context combinations currently registered.
    
    Returns:
    
    An immutable snapshot of all options data
  - getOptions
```
Map<String,String> getOptions(Set<Context> contexts)
```
    Gets options for a specific context combination.
    
    Parameters:
    
    contexts - The context combination to get options for
    
    Returns:
    
    All available options, returning an empty map if none are present
  - setOption
```
CompletableFuture<Boolean> setOption(Set<Context> contexts,
                                     String key,
                                     @Nullable
                                     String value)
```
    Sets a specific option to a value.
    Passing a null value will unset the option.
    
    Parameters:
    
    contexts - The context combination to set the given option in
    
    key - The key to set. Case-insensitive.
    
    value - The value to set.
    
    Returns:
    
    Whether the operation was successful
  - clearOptions
```
CompletableFuture<Boolean> clearOptions()
```
    Clear all options.
    
    Returns:
    
    Whether the operation was successful
  - clearOptions
```
CompletableFuture<Boolean> clearOptions(Set<Context> contexts)
```
    Clear all options in the given context combination.
    Passing an empty context set clears options in the global context.
    
    Parameters:
    
    contexts - The context combination
    
    Returns:
    
    Whether the operation was successful (any options were removed)

Interface SubjectData

Field Summary

Method Summary

Field Detail

GLOBAL_CONTEXT

Method Detail

getAllPermissions

getPermissions

setPermission

clearPermissions

clearPermissions

getAllParents

getParents

addParent

removeParent

clearParents

clearParents

getAllOptions

getOptions

setOption

clearOptions

clearOptions