eo-runtime/src/main/java/org/eolang/AtVoid.java

Summary

Maintainability
A
45 mins
Test Coverage
/*
 * 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;

import java.util.concurrent.atomic.AtomicReference;

/**
 * Void attribute.
 *
 * The attribute is not yet set, but can be set. It's writable, but
 * only once.
 *
 * @since 0.1
 */
@Versionized
public final class AtVoid implements Attr {
    /**
     * Name of the attribute.
     */
    private final String name;

    /**
     * Object that attribute keeps.
     */
    private final AtomicReference<Phi> object;

    /**
     * Ctor.
     * @param name The name of the attribute
     */
    public AtVoid(final String name) {
        this(name, null);
    }

    /**
     * Ctor for copying.
     * @param name Name of the attribute
     * @param phi Object
     */
    private AtVoid(final String name, final Phi phi) {
        this.name = name;
        this.object = new AtomicReference<>(phi);
    }

    @Override
    public String toString() {
        final String term;
        if (this.object.get() == null) {
            term = Term.EMPTY;
        } else {
            term = String.format("%sV", this.object.get().toString());
        }
        return term;
    }

    @Override
    public String φTerm() {
        final String term;
        if (this.object.get() == null) {
            term = Term.EMPTY;
        } else {
            term = this.object.get().φTerm();
        }
        return term;
    }

    @Override
    public Attr copy(final Phi self) {
        final Phi obj = this.object.get();
        final Phi copy;
        if (obj == null) {
            copy = null;
        } else {
            copy = obj.copy();
        }
        return new AtVoid(this.name, copy);
    }

    @Override
    public Phi get() {
        final Phi phi = this.object.get();
        if (phi == null) {
            throw new ExUnset(
                String.format(
                    "The attribute '%s' is not initialized, can't read", this.name
                )
            );
        }
        return phi;
    }

    @Override
    public boolean put(final Phi phi) {
        if (this.object.get() == null) {
            this.object.set(phi);
        } else {
            throw new ExReadOnly(
                "This void attribute is already set, can't reset"
            );
        }
        return true;
    }

}