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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of legaldocml-core Show documentation
The newest version!
package io.legaldocml.akn.element;

import com.google.common.collect.ImmutableMap;
import io.legaldocml.akn.AknObject;
import io.legaldocml.akn.attribute.EfficacyModType;
import io.legaldocml.akn.type.EfficacyMods;
import io.legaldocml.io.AttributeGetterSetter;
import io.legaldocml.io.XmlWriter;
import io.legaldocml.io.impl.Buffers;

import java.io.IOException;

import static io.legaldocml.akn.AknAttributes.TYPE;
import static io.legaldocml.akn.AknElements.EFFICACY_MOD;
import static io.legaldocml.akn.element.Attributes.attributeGetterSetter4Enum;
import static io.legaldocml.akn.util.XmlWriterHelper.writeEfficacyMods;
import static io.legaldocml.unsafe.UnsafeHelper.getFieldOffset;

/**
 * The element efficacyMod is a metadata element specifying an (active or passive) modification in efficacy for the
 * document.
 * 
 * 
 *   
 * 	   
 * 	     
 * 		   
 * 		     
 * 		   
 * 	     
 * 	   
 *   
 * 
 *
 * @author Jacques Militello
 */
public final class EfficacyMod extends ModificationType implements EfficacyModType, AmendmentsElement {

    /**
     * Memory address.
     */
    private static final long ADDRESS_EFFICACY_MOD = Buffers.address(EFFICACY_MOD);

    private static final ImmutableMap> ATTRIBUTES;

    static {
        ATTRIBUTES = ImmutableMap.>builder()
                .putAll(ModificationType.ATTRIBUTES)
                .put(TYPE, attributeGetterSetter4Enum(TYPE, getFieldOffset(EfficacyMod.class, "type"), EfficacyMods.class))
                .build();
    }

    private EfficacyMods type;

    public EfficacyMods getType() {
        return this.type;
    }

    public void setType(EfficacyMods type) {
        this.type = type;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void write(XmlWriter writer) throws IOException {
        writer.writeStart(ADDRESS_EFFICACY_MOD, 11);
        writeEfficacyMods(writer, this);
        super.write(writer);
        writer.writeEnd(ADDRESS_EFFICACY_MOD, 11);
    }

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

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