org.wildfly.naming.client.CloseableNamingEnumeration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wildfly-naming-client Show documentation
There is a newer version: 2.0.1.Final
Show newest version
/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2015, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.wildfly.naming.client;

import java.util.Collections;
import java.util.Enumeration;
import java.util.Iterator;

import javax.naming.NamingEnumeration;
import javax.naming.NamingException;

import org.wildfly.common.Assert;

/**
 * A naming enumeration which works with {@code try}-with-resources.
 *
 * @author David M. Lloyd
 */
public interface CloseableNamingEnumeration extends NamingEnumeration, NamingCloseable {

    /**
     * Close the enumeration.
     *
     * @throws NamingException if closing the enumeration failed for some reason
     */
    void close() throws NamingException;

    /**
     * Create a naming enumeration from an iterable collection.
     *
     * @param iterable the iterable
     * @param  the element type
     * @return the enumeration
     */
    static  CloseableNamingEnumeration fromIterable(Iterable iterable) {
        Assert.checkNotNullParam("iterable", iterable);
        return fromIterator(iterable.iterator());
    }

    /**
     * Create a naming enumeration from a collection iterator.
     *
     * @param iterator the iterator
     * @param  the element type
     * @return the enumeration
     */
    static  CloseableNamingEnumeration fromIterator(Iterator iterator) {
        Assert.checkNotNullParam("iterator", iterator);
        return new CloseableNamingEnumeration() {
            public T next() {
                return nextElement();
            }

            public boolean hasMore() {
                return hasMoreElements();
            }

            public void close() {
            }

            public boolean hasMoreElements() {
                return iterator.hasNext();
            }

            public T nextElement() {
                return iterator.next();
            }
        };
    }

    /**
     * Create a naming enumeration from a collection enumeration.
     *
     * @param enumeration the enumeration
     * @param  the element type
     * @return the enumeration
     */
    static  CloseableNamingEnumeration fromEnumeration(Enumeration enumeration) {
        Assert.checkNotNullParam("enumeration", enumeration);
        if (enumeration instanceof CloseableNamingEnumeration) {
            return (CloseableNamingEnumeration) enumeration;
        } else if (enumeration instanceof NamingEnumeration) {
            return fromEnumeration((NamingEnumeration) enumeration);
        }
        return new CloseableNamingEnumeration() {
            public T next() {
                return nextElement();
            }

            public boolean hasMore() {
                return hasMoreElements();
            }

            public void close() {
            }

            public boolean hasMoreElements() {
                return enumeration.hasMoreElements();
            }

            public T nextElement() {
                return enumeration.nextElement();
            }
        };
    }

    /**
     * Create a closeable naming enumeration from a naming enumeration.
     *
     * @param enumeration the enumeration
     * @param  the element type
     * @return the enumeration
     */
    static  CloseableNamingEnumeration fromEnumeration(NamingEnumeration enumeration) {
        Assert.checkNotNullParam("enumeration", enumeration);
        if (enumeration instanceof CloseableNamingEnumeration) {
            return (CloseableNamingEnumeration) enumeration;
        }
        return new CloseableNamingEnumeration() {
            public T next() throws NamingException {
                return enumeration.next();
            }

            public boolean hasMore() throws NamingException {
                return enumeration.hasMore();
            }

            public void close() throws NamingException {
                enumeration.close();
            }

            public boolean hasMoreElements() {
                return enumeration.hasMoreElements();
            }

            public T nextElement() {
                return enumeration.nextElement();
            }
        };
    }

    CloseableNamingEnumeration EMPTY = fromEnumeration(Collections.emptyEnumeration());

    @SuppressWarnings("unchecked")
    static  CloseableNamingEnumeration empty() {
        return (CloseableNamingEnumeration) EMPTY;
    }
}