io.legaldocml.akn.element.Formula Maven / Gradle / Ivy

Go to download
package io.legaldocml.akn.element;

import com.google.common.collect.ImmutableMap;
import io.legaldocml.akn.AknAttributes;
import io.legaldocml.akn.attribute.Name;
import io.legaldocml.akn.group.BasicContainers;
import io.legaldocml.akn.group.PreambleContainers;
import io.legaldocml.akn.group.PrefaceContainers;
import io.legaldocml.io.CharArray;
import io.legaldocml.io.Externalizable;
import io.legaldocml.io.XmlWriter;
import io.legaldocml.io.impl.Buffers;

import java.io.IOException;
import java.util.function.BiConsumer;

import static io.legaldocml.akn.AknElements.FORMULA;
import static io.legaldocml.akn.element.Attributes.biConsumerString;
import static io.legaldocml.akn.util.XmlWriterHelper.writeName;
import static io.legaldocml.unsafe.UnsafeHelper.getFieldOffset;

/**
 * the element formula is a section of the preface or preamble that contains a formulaic expression that is
 * systematically or frequently present in a preface or a preamble and has e precise legal meaning (e.g. an enacting
 * formula). Use the refersTo attribute for the specification of the actual type of formula.
 *
 *  *   
 * 	   
 *       
 *         
 *           
 *         
 *       
 *     
 *   
 * 
 *
 * @author Jacques Militello
 */
public final class Formula extends Blocksreq implements Name, PreambleContainers, BasicContainers, PrefaceContainers, SubFlowStructureElement, PortionBodyTypeElement {

    /**
     * Memory address.
     */
    private static final long ADDRESS_FORMULA = Buffers.address(FORMULA);

    protected static final ImmutableMap> ATTRIBUTES;

    static {
        ATTRIBUTES = ImmutableMap.>builder()
                .putAll(Blocksreq.ATTRIBUTES)
                .put(AknAttributes.NAME, biConsumerString(getFieldOffset(Formula.class, "name")))
                .build();
    }

    private String name;

    /**
     * {@inheritDoc}
     */
    @Override
    public String getName() {
        return this.name;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void setName(String name) {
        this.name = name;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void write(XmlWriter writer) throws IOException {
        writer.writeStart(ADDRESS_FORMULA, 7);
        if (writer.getVersion() >= 3) {
            writeName(writer, this);
        }
        super.write(writer);
        writer.writeEnd(ADDRESS_FORMULA, 7);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String name() {
        return FORMULA;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public ImmutableMap> attributes() {
        return ATTRIBUTES;
    }
}