org.eolang.maven.objectionary.Objectionaries Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of eo-maven-plugin Show documentation
EO-to-Java Maven Plugin
The newest version!
/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2016-2024 Objectionary.com
 *
 * 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 NON-INFRINGEMENT. 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.eolang.maven.objectionary;

import java.io.IOException;
import org.cactoos.Input;
import org.eolang.maven.name.ObjectName;

/**
 * Many objectionaries for different hashes.
 * @since 0.29.6
 */
public interface Objectionaries {

    /**
     * Get an object by hash and name.
     * @param name Object name
     * @return Object
     * @throws IOException If some I/O problem happens.
     */
    Input object(ObjectName name) throws IOException;

    /**
     * Check if an object exists.
     *
     * @param name Object name
     * @return True if an object exists, false otherwise
     * @throws IOException If some I/O problem happens.
     */
    boolean contains(ObjectName name) throws IOException;

    /**
     * Fake objectionaries.
     * Contains only one default objectionary that will be returned by any hash.
     *
     * @since 0.29.6
     */
    final class Fake implements Objectionaries {
        /**
         * Default objectionary.
         */
        private final Objectionary objectionary;

        /**
         * Ctor.
         */
        public Fake() {
            this(new Objectionary.Fake());
        }

        /**
         * Ctor.
         * @param objry Default objectionary
         */
        public Fake(final Objectionary objry) {
            this.objectionary = objry;
        }

        @Override
        public Input object(final ObjectName name) throws IOException {
            return this.objectionary.get(name.value());
        }

        @Override
        public boolean contains(final ObjectName name) throws IOException {
            return this.objectionary.contains(name.value());
        }
    }
}