Ban (SpongeAPI 7.3.0 API)

All Known Subinterfaces:

Ban.Ip, Ban.Profile
```
public interface Ban
```
Represents a ban made on an object.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Ban.Builder` Represents a builder that creates bans.
`static interface`	`Ban.Ip` Represents a ban made on an IP.
`static interface`	`Ban.Profile` Represents a ban made on a `GameProfile`.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static Ban.Builder`	`builder()` Creates a new Builder.
`Optional<CommandSource>`	`getBanCommandSource()` Gets the source that created this ban in `CommandSource` form, if available.
`Optional<Text>`	`getBanSource()` Gets the source that created this ban, if available.
`Instant`	`getCreationDate()` Gets the creation date of the ban.
`Optional<Instant>`	`getExpirationDate()` Gets the expiration date of this ban, if available.
`Optional<Text>`	`getReason()` Gets the reason for the ban, if available.
`BanType`	`getType()` Gets the type of this ban.
`default boolean`	`isIndefinite()` Gets whether this ban is indefinitely long, e.g.
`static Ban`	`of(GameProfile profile)` Creates an indefinite ban on a profile.
`static Ban`	`of(GameProfile profile, Text reason)` Creates an indefinite ban with a reason on a profile.

- Method Detail
  - builder
```
static Ban.Builder builder()
```
    Creates a new Builder.
    
    Returns:
    
    A new ban builder
  - of
```
static Ban of(GameProfile profile)
```
    Creates an indefinite ban on a profile.
    
    Parameters:
    
    profile - The profile
    
    Returns:
    
    The created ban
  - of
```
static Ban of(GameProfile profile,
              Text reason)
```
    Creates an indefinite ban with a reason on a profile.
    
    Parameters:
    
    profile - The profile
    
    reason - The reason
    
    Returns:
    
    The created ban
  - getType
```
BanType getType()
```
    Gets the type of this ban.
    
    Returns:
    
    The ban type
  - getReason
```
Optional<Text> getReason()
```
    Gets the reason for the ban, if available.
    
    Returns:
    
    The reason specified for the ban, if available
  - getCreationDate
```
Instant getCreationDate()
```
    Gets the creation date of the ban.
    Note that this Instant has no effect on whether or not a ban is active. Any ban for which BanService.hasBan(Ban) returns true will be used (when checking if a player can join, for example), regardless of its creation date.
    
    Returns:
    
    Creation date of the ban
  - getBanSource
```
Optional<Text> getBanSource()
```
    Gets the source that created this ban, if available.
    Depending on the implementation, the returned Text may represent a CommandSource. getBanCommandSource() can be used to attempt to convert the source to a CommandSource.
    
    Returns:
    
    the source of this ban, if available
  - getBanCommandSource
```
Optional<CommandSource> getBanCommandSource()
```
    Gets the source that created this ban in CommandSource form, if available.
    Depending on the implementation, it may not be possible to determine the CommandSource responsible for this ban. Because of this, it is recommended to check getBanSource() if this method returns Optional.empty().
    
    Returns:
    
    The banning source or Optional.empty()
  - getExpirationDate
```
Optional<Instant> getExpirationDate()
```
    Gets the expiration date of this ban, if available.
    
    Returns:
    
    Expiration time of the ban or Optional.empty()
  - isIndefinite
```
default boolean isIndefinite()
```
    Gets whether this ban is indefinitely long, e.g. has no expiration date.
    
    Returns:
    
    True if this ban has no expiration date, otherwise false

Interface Ban

Nested Class Summary

Method Summary

Method Detail

builder

of

of

getType

getReason

getCreationDate

getBanSource

getBanCommandSource

getExpirationDate

isIndefinite