org.spongepowered.api.data.value.CollectionValue Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spongeapi Show documentation
Show all versions of spongeapi Show documentation
A plugin API for Minecraft: Java Edition
/*
* This file is part of SpongeAPI, licensed under the MIT License (MIT).
*
* Copyright (c) SpongePowered
* Copyright (c) contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.spongepowered.api.data.value;
import java.util.Collection;
import java.util.function.Function;
import java.util.function.Predicate;
/**
* A {@link Collection} based {@link Value} type. Since some collections
* are complex, or can be {@link Collection#isEmpty() empty}, this exposes
* some of the common methods found in {@link Collection} and it itself
* is {@link Iterable}. This is the base class for the common collections,
* like {@link ListValue} and {@link SetValue}.
*
* @param The type of element
* @param The type of collection
*/
public interface CollectionValue> extends Value, Iterable {
/**
* Gets the size of the underlying collection of elements.
*
* @return The size
*/
int size();
/**
* Checks if the backed {@link Collection} is empty.
*
* @see Collection#isEmpty()
* @return True if the collection is empty
*/
boolean isEmpty();
/**
* Checks if the given E element is contained within the backed
* {@link Collection}.
*
* @param element The element to check
* @return True if the element is contained in this collection
*/
boolean contains(E element);
/**
* Checks if all of the given elements in the provided {@link Iterable} are
* contained within the backed {@link Collection}.
*
* @param iterable The iterable elements
* @return True if all elements are contained within the backed collection
*/
boolean containsAll(Iterable iterable);
/**
* Creates a new {@link Collection} of the proper type C with
* all elements copied to the new collection. Any modifications to the new
* collection are not reflected to this {@link Mutable}. Likewise,
* no modifications to this {@link Mutable} are reflected to the
* returned {@link Collection}.
*
* @return A new collection with all elements copied
*/
C all();
@Override
CollectionValue.Mutable asMutable();
@Override
CollectionValue.Mutable asMutableCopy();
@Override
CollectionValue.Immutable asImmutable();
/**
* A {@link org.spongepowered.api.data.value.Value.Immutable} type that handles a {@link Collection} of elements
* type E. All of the methods provided for modification return new
* instances of the same type. Likewise, the underlying {@link ValueContainer}
* is not modified.
*
* @param The type of element
* @param The type of {@link Collection}
* @param The extended {@link org.spongepowered.api.data.value.CollectionValue.Immutable} for self referencing
* @param The mutable {@link org.spongepowered.api.data.value.CollectionValue.Mutable} counterpart for {@link #asMutable()}
*/
interface Immutable, I extends Immutable, M extends Mutable>
extends Value.Immutable, CollectionValue {
/**
* Creates a new {@link org.spongepowered.api.data.value.CollectionValue.Immutable} with the given values
* along with any pre-existing values within this value.
*
* @param element The element to add
* @return The new value
*/
I withElement(E element);
/**
* Creates a new {@link org.spongepowered.api.data.value.CollectionValue.Immutable} with the given elements
* along with any pre-existing values within this value.
*
* @see Collection#addAll(Collection)
*
* @param elements The elements to add
* @return The new value
*/
I withAll(Iterable elements);
/**
* Creates a new {@link org.spongepowered.api.data.value.CollectionValue.Immutable} without the given
* E element.
*
* @param element The element to exclude
* @return The new value
*/
I without(E element);
/**
* Creates a new {@link org.spongepowered.api.data.value.CollectionValue.Immutable} without the given
* elements of the provided {@link Iterable}.
*
* @param elements The elements to exclude
* @return The new value
*/
I withoutAll(Iterable elements);
/**
* Creates a new {@link org.spongepowered.api.data.value.CollectionValue.Immutable} with elements that
* when the given {@link Predicate} is {@link Predicate#test(Object)} on
* the element and {@code true} is returned, the element will remain in the
* new {@link org.spongepowered.api.data.value.CollectionValue.Immutable}.
*
* @param predicate The predicate to apply
* @return The new value
*/
I withoutAll(Predicate predicate);
@Override
I with(C value);
@Override
I transform(Function function);
@Override
M asMutable();
@Override
default M asMutableCopy() {
return this.asMutable();
}
@SuppressWarnings("unchecked")
@Override
default I asImmutable() {
return (I) this;
}
}
/**
* Represents a {@link org.spongepowered.api.data.value.Value.Mutable} that is backed by a {@link Collection} of
* elements.
*
* @param The type of element
* @param The type of collection, for chaining
* @param The type of {@linkplain org.spongepowered.api.data.value.CollectionValue.Mutable}
* @param The type of {@link org.spongepowered.api.data.value.CollectionValue.Immutable}
*/
interface Mutable, M extends Mutable, I extends Immutable>
extends Value.Mutable, CollectionValue, Iterable {
/**
* Adds the given {@code element} to this {@link org.spongepowered.api.data.value.CollectionValue.Mutable}.
*
* @param element The element to add
* @return This value, for chaining
*/
M add(E element);
/**
* Adds all the given {@link Iterable} {@code elements} to the underlying
* {@link Collection}.
*
* @see Collection#addAll(Collection)
*
* @param elements The elements to add
* @return This value, for chaining
*/
M addAll(Iterable elements);
/**
* Removes the given {@code element} from the backed {@link Collection}.
*
* @param element The element to remove
* @return This value, for chaining
*/
M remove(E element);
/**
* Removes all elements from the {@link Iterable} from the backed
* {@link Collection}.
*
* @param elements The elements to remove
* @return This value, for chaining
*/
M removeAll(Iterable elements);
/**
* Iterates over all existing elements and removes any elements that
* {@link Predicate#test(Object)} returns {@code true}.
*
* @param predicate The predicate to remove elements
* @return This value, for chaining
*/
M removeAll(Predicate predicate);
@Override
M set(C value);
@Override
M transform(Function function);
@Override
M copy();
@Override
default M asMutableCopy() {
return this.copy();
}
@SuppressWarnings("unchecked")
@Override
default M asMutable() {
return (M) this;
}
@Override
I asImmutable();
}
}