poi/poi-scratchpad/src/main/java/org/apache/poi/hwpf/model/types/LFOAbstractType.java

/* ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You 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

       http://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 org.apache.poi.hwpf.model.types;

import java.util.Objects;

import org.apache.poi.hwpf.model.Grfhic;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian;

/**
 * List Format Override (LFO).
 */
@Internal
public abstract class LFOAbstractType
{

    protected int field_1_lsid;
    protected int field_2_unused1;
    protected int field_3_unused2;
    protected byte field_4_clfolvl;
    protected byte field_5_ibstFltAutoNum;
    protected Grfhic field_6_grfhic;
    protected byte field_7_unused3;

    protected LFOAbstractType()
    {
        this.field_6_grfhic = new Grfhic();
    }

    protected void fillFields( byte[] data, int offset )
    {
        field_1_lsid                   = LittleEndian.getInt( data, 0x0 + offset );
        field_2_unused1                = LittleEndian.getInt( data, 0x4 + offset );
        field_3_unused2                = LittleEndian.getInt( data, 0x8 + offset );
        field_4_clfolvl                = data[ 0xc + offset ];
        field_5_ibstFltAutoNum         = data[ 0xd + offset ];
        field_6_grfhic                 = new Grfhic( data, 0xe + offset );
        field_7_unused3                = data[ 0xf + offset ];
    }

    public void serialize( byte[] data, int offset )
    {
        LittleEndian.putInt( data, 0x0 + offset, field_1_lsid );
        LittleEndian.putInt( data, 0x4 + offset, field_2_unused1 );
        LittleEndian.putInt( data, 0x8 + offset, field_3_unused2 );
        data[ 0xc + offset ] = field_4_clfolvl;
        data[ 0xd + offset ] = field_5_ibstFltAutoNum;
        field_6_grfhic.serialize( data, 0xe + offset );
        data[ 0xf + offset ] = field_7_unused3;
    }

    public byte[] serialize()
    {
        final byte[] result = new byte[ getSize() ];
        serialize( result, 0 );
        return result;
    }

    /**
     * Size of record
     */
    public static int getSize()
    {
        return 0 + 4 + 4 + 4 + 1 + 1 + 1 + 1;
    }

    @Override
    public boolean equals( Object obj )
    {
        if ( this == obj )
            return true;
        if ( obj == null )
            return false;
        if ( getClass() != obj.getClass() )
            return false;
        LFOAbstractType other = (LFOAbstractType) obj;
        if ( field_1_lsid != other.field_1_lsid )
            return false;
        if ( field_2_unused1 != other.field_2_unused1 )
            return false;
        if ( field_3_unused2 != other.field_3_unused2 )
            return false;
        if ( field_4_clfolvl != other.field_4_clfolvl )
            return false;
        if ( field_5_ibstFltAutoNum != other.field_5_ibstFltAutoNum )
            return false;
        if ( field_6_grfhic == null )
        {
            if ( other.field_6_grfhic != null )
                return false;
        }
        else if ( !field_6_grfhic.equals( other.field_6_grfhic ) )
            return false;
        if ( field_7_unused3 != other.field_7_unused3 )
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        return Objects.hash(field_1_lsid, field_2_unused1, field_3_unused2, field_4_clfolvl, field_5_ibstFltAutoNum,
                            field_6_grfhic, field_7_unused3);
    }

    public String toString()
    {
        StringBuilder builder = new StringBuilder();

        builder.append("[LFO]\n");
        builder.append( "    .lsid                 = " );
        builder.append(" ( ").append( field_1_lsid ).append( " )\n" );
        builder.append( "    .unused1              = " );
        builder.append(" ( ").append( field_2_unused1 ).append( " )\n" );
        builder.append( "    .unused2              = " );
        builder.append(" ( ").append( field_3_unused2 ).append( " )\n" );
        builder.append( "    .clfolvl              = " );
        builder.append(" ( ").append( field_4_clfolvl ).append( " )\n" );
        builder.append( "    .ibstFltAutoNum       = " );
        builder.append(" ( ").append( field_5_ibstFltAutoNum ).append( " )\n" );
        builder.append( "    .grfhic               = " );
        builder.append(" ( ").append( field_6_grfhic == null ? "null" : field_6_grfhic.toString().replaceAll( "\n", "\n    " ) ).append( " )\n" );
        builder.append( "    .unused3              = " );
        builder.append(" ( ").append( field_7_unused3 ).append( " )\n" );

        builder.append("[/LFO]");
        return builder.toString();
    }

    /**
     * A signed integer that specifies the list identifier of an LSTF. This LFO corresponds to the LSTF in PlfLst.rgLstf that has an lsid whose value is equal to this value..
     */
    @Internal
    public int getLsid()
    {
        return field_1_lsid;
    }

    /**
     * A signed integer that specifies the list identifier of an LSTF. This LFO corresponds to the LSTF in PlfLst.rgLstf that has an lsid whose value is equal to this value..
     */
    @Internal
    public void setLsid( int field_1_lsid )
    {
        this.field_1_lsid = field_1_lsid;
    }

    /**
     * This field MUST be ignored.
     */
    @Internal
    public int getUnused1()
    {
        return field_2_unused1;
    }

    /**
     * This field MUST be ignored.
     */
    @Internal
    public void setUnused1( int field_2_unused1 )
    {
        this.field_2_unused1 = field_2_unused1;
    }

    /**
     * This field MUST be ignored.
     */
    @Internal
    public int getUnused2()
    {
        return field_3_unused2;
    }

    /**
     * This field MUST be ignored.
     */
    @Internal
    public void setUnused2( int field_3_unused2 )
    {
        this.field_3_unused2 = field_3_unused2;
    }

    /**
     * An unsigned integer that specifies the field that this LFO represents..
     */
    @Internal
    public byte getClfolvl()
    {
        return field_4_clfolvl;
    }

    /**
     * An unsigned integer that specifies the field that this LFO represents..
     */
    @Internal
    public void setClfolvl( byte field_4_clfolvl )
    {
        this.field_4_clfolvl = field_4_clfolvl;
    }

    /**
     * Used for AUTONUM field emulation.
     */
    @Internal
    public byte getIbstFltAutoNum()
    {
        return field_5_ibstFltAutoNum;
    }

    /**
     * Used for AUTONUM field emulation.
     */
    @Internal
    public void setIbstFltAutoNum( byte field_5_ibstFltAutoNum )
    {
        this.field_5_ibstFltAutoNum = field_5_ibstFltAutoNum;
    }

    /**
     * HTML compatibility flags.
     */
    @Internal
    public Grfhic getGrfhic()
    {
        return field_6_grfhic;
    }

    /**
     * HTML compatibility flags.
     */
    @Internal
    public void setGrfhic( Grfhic field_6_grfhic )
    {
        this.field_6_grfhic = field_6_grfhic;
    }

    /**
     * This field MUST be ignored.
     */
    @Internal
    public byte getUnused3()
    {
        return field_7_unused3;
    }

    /**
     * This field MUST be ignored.
     */
    @Internal
    public void setUnused3( byte field_7_unused3 )
    {
        this.field_7_unused3 = field_7_unused3;
    }

}  // END OF CLASS