Chunk.java

/**
 * JHOVE2 - Next-generation architecture for format-aware characterization
 *
 * Copyright (c) 2009 by The Regents of the University of California.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * o Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * o Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * o Neither the name of the University of California/California Digital
 *   Library, Ithaka Harbors/Portico, or Stanford University, nor the names of
 *   its contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

package org.jhove2.module.format.riff;

import java.util.List;
import org.jhove2.annotation.ReportableProperty;
import org.jhove2.core.reportable.Reportable;
import org.jhove2.module.format.Parser;
import org.jhove2.module.format.Validator.Validity;

/** Resource Interchange File Format (RIFF) chunk interface.
 * 
 * @author slabrams
 */
public interface Chunk
    extends Parser, Reportable
{
    /** Get child chunks.
     * @return Child chunks
     */
    @ReportableProperty(order=4, value="Child chunks.")
    public List<Chunk> getChildChunks();
 
    /** Get the chunk identifier.
     * @return Chunk identifier
     */
    @ReportableProperty(order=1, value="Chunk identifier.")
    public String getIdentifier();
    
    /** Get next chunk starting offset, in bytes.
     * @return Next chunk starting offset
     */
    public long getNextChunkOffset();
    
    /** Get starting offset of chunk, in bytes.
     * @return Starting offset of chunk
     */
    public long getOffset();
 
    /** Get the chunk data size, in bytes.
     * @return Chunk data size
     */
    @ReportableProperty(order=2, value="Chunk data size, in bytes.")
    public long getSize();
    
    /** Get chunk pad byte status.
     * @return Chunk pad byte status
     */
    @ReportableProperty(order=3, value="Chunk pad byte status.")
    public boolean hasPadByte();
    
    /** Get chunk validation status.
     * @return Chunk validation statue
     */
    @ReportableProperty(order=5, value="Chunk validation status.")
    public Validity isValid();
    
    /** Set chunk identifier.
     * @param identifier Chunk identifier
     */
    public void setIdentifier(String identifier);
}