io.legaldocml.akn.element.Note 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.Notes;
import io.legaldocml.akn.type.EidRef;
import io.legaldocml.akn.type.PlacementType;
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.NOTE;
import static io.legaldocml.akn.element.Attributes.biConsumerEidRef;
import static io.legaldocml.akn.element.Attributes.biConsumerEnum;
import static io.legaldocml.akn.element.Attributes.biConsumerString;
import static io.legaldocml.akn.util.XmlWriterHelper.writeNotes;
import static io.legaldocml.unsafe.UnsafeHelper.getFieldOffset;

/**
 * The element note is a metadata element containing the text of the footnote and endnote specified.
 *
 *  *   
 * 	   
 *       
 *         
 *           
 *         
 *       
 *     
 * 	 
 * 
 *
 * @author Jacques Militello
 */
public final class Note extends SubFlowStructure implements Notes {

    /**
     * Memory address.
     */
    private static final long ADDRESS_NOTE = Buffers.address(NOTE);


    private static final ImmutableMap> ATTRIBUTES;

    static {
        ATTRIBUTES = ImmutableMap.>builder()
                .putAll(SubFlowStructure.ATTRIBUTES)
                .put(AknAttributes.MARKER, biConsumerString(getFieldOffset(Note.class, "marker")))
                .put(AknAttributes.PLACEMENT_BASE, biConsumerEidRef(getFieldOffset(Note.class, "placementBase")))
                .put(AknAttributes.PLACEMENT, biConsumerEnum(getFieldOffset(Note.class, "placement"), PlacementType.class))
                .build();
    }

    private String marker;
    private PlacementType placement;
    private EidRef placementBase;

    /**
     * {@inheritDoc}
     */
    @Override
    public String getMarker() {
        return this.marker;
    }

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

    /**
     * {@inheritDoc}
     */
    @Override
    public PlacementType getPlacement() {
        return this.placement;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void setPlacement(PlacementType placement) {
        this.placement = placement;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public EidRef getPlacementBase() {
        return this.placementBase;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void setPlacementBase(EidRef placementBase) {
        this.placementBase = placementBase;
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public void write(XmlWriter writer) throws IOException {
        writer.writeStart(ADDRESS_NOTE, 4);
        writeNotes(writer, this);
        super.write(writer);
        writer.writeEnd(ADDRESS_NOTE, 4);
    }

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

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