poi/src/scratchpad/src/org/apache/poi/hwpf/model/FootnoteReferenceDescriptor.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;

import java.util.Objects;

import org.apache.poi.common.Duplicatable;
import org.apache.poi.hwpf.model.types.FRDAbstractType;
import org.apache.poi.util.Internal;
import org.apache.poi.util.Removal;

@Internal
public final class FootnoteReferenceDescriptor extends FRDAbstractType implements Duplicatable {
    public FootnoteReferenceDescriptor() { }

    public FootnoteReferenceDescriptor(FootnoteReferenceDescriptor other) {
        super(other);
    }

    public FootnoteReferenceDescriptor( byte[] data, int offset ) {
        fillFields( data, offset );
    }

    @Override
    @SuppressWarnings("squid:S2975")
    @Deprecated
    @Removal(version = "5.0.0")
    protected FootnoteReferenceDescriptor clone() {
        return copy();
    }

    @Override
    public FootnoteReferenceDescriptor copy() {
        return new FootnoteReferenceDescriptor(this);
    }

    @Override
    public boolean equals( Object obj )
    {
        if ( this == obj )
            return true;
        if ( obj == null )
            return false;
        if ( getClass() != obj.getClass() )
            return false;
        FootnoteReferenceDescriptor other = (FootnoteReferenceDescriptor) obj;
        if ( field_1_nAuto != other.field_1_nAuto )
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        return Objects.hash(field_1_nAuto);
    }

    public boolean isEmpty()
    {
        return field_1_nAuto == 0;
    }

    @Override
    public String toString()
    {
        if ( isEmpty() )
            return "[FRD] EMPTY";

        return super.toString();
    }
}