AbstractPngTextChunk.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
 *
 *      https://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.commons.imaging.formats.png.chunks;

import org.apache.commons.imaging.formats.png.AbstractPngText;

/**
 * Abstract class for PNG text chunks.
 */
public abstract class AbstractPngTextChunk extends PngChunk {

    /**
     * Constructs a new PNG text chunk.
     *
     * @param length the length of the chunk data.
     * @param chunkType the chunk type.
     * @param crc the CRC value.
     * @param bytes the chunk data bytes.
     */
    public AbstractPngTextChunk(final int length, final int chunkType, final int crc, final byte[] bytes) {
        super(length, chunkType, crc, bytes);
    }

    /**
     * Gets the text contents of this chunk.
     *
     * @return the text contents.
     */
    public abstract AbstractPngText getContents();

    /**
     * Gets the keyword of this text chunk.
     *
     * @return the keyword.
     */
    public abstract String getKeyword();

    /**
     * Gets the text value of this text chunk.
     *
     * @return the text.
     */
    public abstract String getText();

}