Package org.incendo.cloud.description

Interface Describable

All Known Subinterfaces:
CommandDescription
All Known Implementing Classes:
CommandComponent, TypedCommandComponent
@API(status=STABLE) public interface Describable
Something that has an associated Description.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull Description
    description()
    Returns the description that describes this object.

  • Method Details

    • description

      @NonNull Description description()
      Returns the description that describes this object.

      This will never return null, and will instead return Description.empty() in the case that no description is present. You may check for emptiness by using Description.isEmpty().

      Returns:
      the description