org.spongepowered.api.util.weighted.UnmodifiableWeightedTable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spongeapi Show documentation
A plugin API for Minecraft: Java Edition
The newest version!
/*
 * 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.util.weighted;

import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.Objects;
import java.util.Random;
import java.util.Spliterator;
import java.util.function.Consumer;
import java.util.function.Predicate;
import java.util.stream.Stream;

/**
 * Creates a WeightedTable that is completely immutable, but still is able
 * to be changed via its proxy table.
 *
 * @param  Item type
 */
public class UnmodifiableWeightedTable extends WeightedTable {

    private final WeightedTable table;

    /**
     * Creates a new {@link UnmodifiableWeightedTable} with the provided
     * {@link WeightedTable}.
     *
     * @param table The table to provide
     */
    public UnmodifiableWeightedTable(final WeightedTable table) {
        super();
        this.table = table;
    }

    /**
     * Creates a new {@link UnmodifiableWeightedTable} with the provided
     * {@link WeightedTable} and {@code rolls}.
     *
     * @param table The table
     * @param rolls The rolls
     */
    public UnmodifiableWeightedTable(final WeightedTable table, final int rolls) {
        super(rolls);
        this.table = table;
    }

    /**
     * Creates a new {@link UnmodifiableWeightedTable} with the provided
     * {@link WeightedTable} and {@link VariableAmount rolls}.
     *
     * @param table The table
     * @param rolls The rolls
     */
    public UnmodifiableWeightedTable(final WeightedTable table, final VariableAmount rolls) {
        super(rolls);
        this.table = table;
    }

    // FORBIDDEN METHODS

    @Override
    public boolean add(final TableEntry entry) {
        throw new UnsupportedOperationException();
    }

    @Override
    public boolean add(final T object, final double weight) {
        throw new UnsupportedOperationException();
    }

    @Override
    public boolean addAll(final Collection> c) {
        throw new UnsupportedOperationException();
    }

    @Override
    public void setRolls(final VariableAmount rolls) {
        throw new UnsupportedOperationException();
    }

    @Override
    public void setRolls(final int rolls) {
        throw new UnsupportedOperationException();
    }

    @Override
    public boolean remove(final Object entry) {
        throw new UnsupportedOperationException();
    }

    @Override
    public boolean removeObject(final Object entry) {
        throw new UnsupportedOperationException();
    }

    @Override
    public boolean removeAll(final Collection c) {
        throw new UnsupportedOperationException();
    }

    @Override
    public boolean removeIf(final Predicate> filter) {
        throw new UnsupportedOperationException();
    }

    @Override
    public boolean retainAll(final Collection c) {
        throw new UnsupportedOperationException();
    }

    @Override
    public void clear() {
        throw new UnsupportedOperationException();
    }

    // PROXY METHODS

    @Override
    public Iterator> iterator() {
        final Iterator> it = this.table.iterator();
        return new Iterator>() {
            @Override
            public boolean hasNext() {
                return it.hasNext();
            }

            @Override
            public TableEntry next() {
                return it.next();
            }

            @Override
            public void remove() {
                throw new UnsupportedOperationException();
            }

            @Override
            public void forEachRemaining(final Consumer> action) {
                it.forEachRemaining(action);
            }
        };
    }

    @Override
    public boolean contains(final Object o) {
        return this.table.contains(o);
    }

    @Override
    public VariableAmount rolls() {
        return this.table.rolls();
    }

    @Override
    public List get(final Random rand) {
        return this.table.get(rand);
    }

    @Override
    public boolean containsObject(final Object obj) {
        return this.table.containsObject(obj);
    }

    @Override
    public boolean containsAll(final Collection c) {
        return this.table.containsAll(c);
    }

    @Override
    public boolean containsAllObjects(final Collection c) {
        return this.table.containsAllObjects(c);
    }

    @Override
    public boolean isEmpty() {
        return this.table.isEmpty();
    }

    @Override
    public int size() {
        return this.table.size();
    }

    @Override
    public List> entries() {
        return this.table.entries();
    }

    @Override
    public Object[] toArray() {
        return this.table.toArray();
    }

    @Override
    public  R[] toArray(final R[] a) {
        return this.table.toArray(a);
    }

    @Override
    public Spliterator> spliterator() {
        return this.table.spliterator();
    }

    @Override
    public Stream> stream() {
        return this.table.stream();
    }

    @Override
    public Stream> parallelStream() {
        return this.table.parallelStream();
    }

    @Override
    public void forEach(final Consumer> action) {
        this.table.forEach(action);
    }

    @Override
    public String toString() {
        return this.table.toString();
    }

    @Override
    public int hashCode() {
        return this.table.hashCode();
    }

    @Override
    public boolean equals(final Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || this.getClass() != o.getClass()) {
            return false;
        }
        if (!super.equals(o)) {
            return false;
        }
        final UnmodifiableWeightedTable that = (UnmodifiableWeightedTable) o;
        return Objects.equals(this.table, that.table);
    }
}