tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-microsoft-module/src/main/java/org/apache/tika/parser/microsoft/onenote/FileChunkReference.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.tika.parser.microsoft.onenote;

import java.util.Objects;

/**
 * A file chunk reference specifies a reference to data in the file.
 * <p>
 * Each file chunk reference contains an <pre>stp</pre> field and a <pre>cb</pre> field.
 * <p>
 * The <pre>stp</pre> field is a stream pointer that specifies the offset, in bytes, from the
 * beginning of the file where the referenced
 * data is located.
 * <p>
 * The <pre>cb</pre> field specifies the size, in bytes, of the referenced data. The sizes, in
 * bytes, of the
 * stp and cb fields are specified by the structures in this section.
 * <p>
 * There are some Special values:
 * <p>
 * fcrNil - Specifies a file chunk reference where all bits of the stp field are set to 1, and
 * all bits of the cb field are set to zero.
 * <p>
 * fcrZero - Specifies a file chunk reference where all bits of the stp and cb fields are set to
 * zero.
 */
class FileChunkReference {

    long stp;
    long cb;

    public FileChunkReference() {

    }

    public FileChunkReference(long stp, long cb) {
        this.stp = stp;
        this.cb = cb;
    }

    public static FileChunkReference nil() {
        return new FileChunkReference(-1L, 0L);
    }

    @Override
    public String toString() {
        return "FileChunkReference{" + "stp=" + stp + ", cb=" + cb + '}';
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        FileChunkReference that = (FileChunkReference) o;
        return stp == that.stp && cb == that.cb;
    }

    @Override
    public int hashCode() {
        return Objects.hash(stp, cb);
    }

    public long getStp() {
        return stp;
    }

    public FileChunkReference setStp(long stp) {
        this.stp = stp;
        return this;
    }

    public long getCb() {
        return cb;
    }

    public FileChunkReference setCb(long cb) {
        this.cb = cb;
        return this;
    }
}