UnicodeCommentExtraField.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.compress.archivers.zip;

/**
 * Info-ZIP Unicode Comment Extra Field (0x6375):
 *
 * <p>
 * Stores the UTF-8 version of the file comment as stored in the central directory header.
 * </p>
 *
 * @see <a href="https://www.pkware.com/documents/casestudies/APPNOTE.TXT">PKWARE APPNOTE.TXT, section 4.6.8</a>
 * @NotThreadSafe super-class is not thread-safe
 */
public class UnicodeCommentExtraField extends AbstractUnicodeExtraField {

    /**
     * Field ID.
     */
    public static final ZipShort UCOM_ID = new ZipShort(0x6375);

    /**
     * Constructs a new instance.
     */
    public UnicodeCommentExtraField() {
    }

    /**
     * Constructs a new instance as Unicode comment extension from the comment given as text as well as the bytes actually written to the archive.
     *
     * @param comment The file comment
     * @param bytes   the bytes actually written to the archive
     */
    public UnicodeCommentExtraField(final String comment, final byte[] bytes) {
        super(comment, bytes);
    }

    /**
     * Assemble as Unicode comment extension from the name given as text as well as the encoded bytes actually written to the archive.
     *
     * @param text  The file name
     * @param bytes the bytes actually written to the archive
     * @param off   The offset of the encoded comment in {@code bytes}.
     * @param len   The length of the encoded comment or comment in {@code bytes}.
     */
    public UnicodeCommentExtraField(final String text, final byte[] bytes, final int off, final int len) {
        super(text, bytes, off, len);
    }

    @Override
    public ZipShort getHeaderId() {
        return UCOM_ID;
    }

}