CharSet.java

/* with char|byte|short|int|long|float|double|obj elem */
/*
 * Copyright 2014 the original author or authors.
 *
 * 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 com.koloboke.collect.set;

import com.koloboke.collect.CharCollection;
import com.koloboke.collect.CharIterator;
import com.koloboke.compile.KolobokeSet;

import javax.annotation.Nonnull;
import java.util.Set;


/**
 * // if !(obj elem) //
 * A {@link Set} specialization with {@code char} elements.
 * // elif obj elem //
 * A set of objects, the library's extension of the classic {@link Set} interface.
 * // endif //
 *
 * <p>Methods, declared in this interface (i. e. not inherited from the superinterfaces),
 * are present only to remove some compile-time ambiguities, they don't have any additional meaning
 * over the specifications from superinterfaces.
 *
 * @see CharSetFactory
 * @see KolobokeSet @KolobokeSet
 */
public interface CharSet/*<>*/ extends CharCollection/*<>*/, Set<Character> {

    /* if !(obj elem) */
    /**
     *{@inheritDoc}
     * @deprecated Use specialization {@link #add(char)} instead
     */
    @Override
    @Deprecated
    boolean add(@Nonnull Character e);
    /* endif */

    /**
     * {@inheritDoc}
     * @deprecated Instead of explicit {@code iterator()} calls, use {@link #cursor()};
     * {@code iterator()} is still sensible only as a backing mechanism for Java 5's for-each
     * statements.
     */
    @Deprecated
    @Nonnull
    @Override
    CharIterator/*<>*/ iterator();
}