uk.co.real_logic.artio.dictionary.ir.Entry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of artio-codecs Show documentation
High-Performance FIX Gateway
There is a newer version: 0.160
/*
 * Copyright 2015-2023 Real Logic Limited.
 *
 * 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
 *
 * https://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 uk.co.real_logic.artio.dictionary.ir;

import org.agrona.LangUtil;
import org.agrona.Verify;
import org.agrona.generation.ResourceConsumer;

import java.io.IOException;
import java.util.Comparator;
import java.util.List;
import java.util.function.BiFunction;
import java.util.function.Function;

public final class Entry
{
    public static final Comparator BY_NAME = Comparator.comparing(Entry::name);

    private boolean required;
    private Element element;
    private boolean isInParent;

    // Only used in shared parent entry in order to store references to child entries
    private List sharedChildEntries;

    public static Entry required(final Element element)
    {
        return new Entry(true, element);
    }

    public static Entry optional(final Element element)
    {
        return new Entry(false, element);
    }

    public  T match(
        final BiFunction withField,
        final BiFunction withGroup,
        final BiFunction withComponent)
    {
        if (element instanceof Field)
        {
            return withField.apply(this, (Field)element);
        }
        else if (element instanceof Group)
        {
            return withGroup.apply(this, (Group)element);
        }
        else if (element instanceof Component)
        {
            return withComponent.apply(this, (Component)element);
        }

        throw new IllegalStateException("Unknown element type: " + element);
    }

    public void forEach(
        final ResourceConsumer withField,
        final ResourceConsumer withGroup,
        final ResourceConsumer withComponent)
    {
        try
        {
            if (element instanceof Field)
            {
                withField.accept((Field)element);
            }
            else if (element instanceof Group)
            {
                withGroup.accept((Group)element);
            }
            else if (element instanceof Component)
            {
                withComponent.accept((Component)element);
            }
            else
            {
                throw new IllegalStateException("Unknown element type: " + element);
            }
        }
        catch (final IOException e)
        {
            LangUtil.rethrowUnchecked(e);
        }
    }

    public  T matchEntry(
        final Function withField,
        final Function withGroup,
        final Function withComponent)
    {
        return match(
            (entry, field) -> withField.apply(entry),
            (entry, group) -> withGroup.apply(entry),
            (entry, component) -> withComponent.apply(entry));
    }

    /**
     * @param required whether this is a required or optional element
     * @param element nullable in the case of forward references
     */
    public Entry(final boolean required, final Element element)
    {
        this.required = required;
        this.element = element;
    }

    public boolean required()
    {
        return required;
    }

    public void required(final boolean required)
    {
        this.required = required;
    }

    public Element element()
    {
        return this.element;
    }

    public Entry element(final Element element)
    {
        Verify.notNull(element, "element");

        this.element = element;
        return this;
    }

    public boolean isField()
    {
        return element() instanceof Field;
    }

    public boolean isComponent()
    {
        return element() instanceof Component;
    }

    public boolean isGroup()
    {
        return element() instanceof Group;
    }

    public String toString()
    {
        return "Entry{" +
            "required=" + required +
            ", element=" + element +
            ", isInParent=" + isInParent +
            '}';
    }

    public void sharedChildEntries(final List sharedChildEntries)
    {
        this.sharedChildEntries = sharedChildEntries;
    }

    public List sharedChildEntries()
    {
        return sharedChildEntries;
    }

    public String name()
    {
        return element().name();
    }

    public int number()
    {
        return ((Field)element()).number();
    }

    public boolean isInParent()
    {
        return isInParent;
    }

    public void isInParent(final boolean isInParent)
    {
        this.isInParent = isInParent;
    }

    public interface Element
    {
        default boolean isEnumField()
        {
            return this instanceof Field && ((Field)this).isEnum();
        }

        String name();
    }
}