Package ch.njol.skript.lang.util.common

Interface AnyContains<Type>

Type Parameters:
Type - the type of objects that this container can check for containment. This represents the expected type of elements that the container is designed to hold or work with. When calling contains(Object), the parameter should be of this type, or safely castable to it. Implementations may use isSafeToCheck(Object) to verify that an object is a suitable candidate before performing a containment check.
All Superinterfaces:
AnyProvider
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface @Deprecated(since="2.13", forRemoval=true) public interface AnyContains<Type> extends AnyProvider
Deprecated, for removal: This API element is subject to removal in a future version.
Use Property.CONTAINS instead.
A provider for anything that contains other things. Anything implementing this (or convertible to this) can be used by the PropCondContains conditions.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    checkSafely(Object value)
    Deprecated, for removal: This API element is subject to removal in a future version.
    The internal method used to verify an object and then check its container.
    boolean
    contains(@UnknownNullability Type value)
    Deprecated, for removal: This API element is subject to removal in a future version.
    If isSafeToCheck(Object) returns false, values will not be passed to this method and will instead return false.
    default boolean
    isSafeToCheck(Object value)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Objects are checked versus this before being cast for contains(Object).

  • Method Details

    • contains

      boolean contains(@UnknownNullability Type value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      If isSafeToCheck(Object) returns false, values will not be passed to this method and will instead return false.
      The null-ness of the parameter depends on whether isSafeToCheck(Object) permits null values.
      Parameters:
      value - The value to test
      Returns:
      Whether this contains value

    • isSafeToCheck

      default boolean isSafeToCheck(Object value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Objects are checked versus this before being cast for contains(Object). If your contains method doesn't accept all objects (e.g. for a List.contains(Object) call) then it can exclude unwanted types (or null values) here.
      Parameters:
      value - The value to check
      Returns:
      Whether the value is safe to call contains(Object) with

    • checkSafely

      @Internal default boolean checkSafely(Object value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      The internal method used to verify an object and then check its container.