org.conqat.lib.commons.collections.UnmodifiableSet Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of teamscale-lib-commons Show documentation

Provides common utility functions

There is a newer version: 2024.7.2

Show newest version

/*
 * Copyright (c) CQSE GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.conqat.lib.commons.collections;

import java.util.Collections;
import java.util.Set;

/**
 * This is a wrapper for a {@link Set} prohibiting all calls which would modify its contents. As the
 * construction of this class is performed in constant time it is prefered over copying the set
 * (which takes linear time). Using this class is also preferred to using the
 * unmodifiableX() in class {@link Collections} as they return the collection base type
 * that does not signal, that the object ist unmodifiable. Using the classes in this package makes
 * unmodifiability more explicit.
 * 
 * All prohibited methods throw an {@link UnsupportedOperationException}. The class is nearly the
 * same as the one returned by {@link Collections#unmodifiableSet(java.util.Set)}, but by making it
 * a public class we can make the return value of some methods more explicit.
 * 
 * @author Benjamin Hummel
 */
public class UnmodifiableSet extends UnmodifiableCollection implements Set {

	/** Version used for serialization. */
	private static final long serialVersionUID = 1;

	/**
	 * Creates a new unmodifiable set from another set. All modifications to the underlying set will
	 * directly be visible in this wrapper.
	 */
	public UnmodifiableSet(Set s) {
		super(s);
	}
}