org.semanticweb.elk.util.collections.chains.Chainable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of elk-util-collections Show documentation

ELK Utilities Collections

The newest version!

package org.semanticweb.elk.util.collections.chains;

/*
 * #%L
 * ELK Utilities Collections
 * $Id:$
 * $HeadURL:$
 * %%
 * Copyright (C) 2011 - 2012 Department of Computer Science, University of Oxford
 * %%
 * 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.
 * #L%
 */

/**
 * Elements that can be inserted and removed from {@link Chain}s
 * 
 * @author "Yevgeny Kazakov"
 * 
 * @param 
 *            the types of the elements in the chain
 */
public interface Chainable> extends
		ModifiableLink {

	/**
	 * Adds this element to the given {@link Chain}
	 * 
	 * @param chain
	 *            the {@link Chain} where to add this element
	 * @return {@code true} if the operation was successful and {@code false}
	 *         otherwise; if {@code false} is returned, this {@link Chain}
	 *         remains unchanged
	 */
	public boolean addTo(Chain chain);

	/**
	 * Removes this element from the given {@link Chain}
	 * 
	 * @param chain
	 *            to be removed
	 * @return {@code true} if the operation was successful and {@code false}
	 *         otherwise; if {@code false} is returned, this {@link Chain}
	 *         remains unchanged
	 */
	public boolean removeFrom(Chain chain);

}