• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  *  Licensed to the Apache Software Foundation (ASF) under one or more
3  *  contributor license agreements.  See the NOTICE file distributed with
4  *  this work for additional information regarding copyright ownership.
5  *  The ASF licenses this file to You under the Apache License, Version 2.0
6  *  (the "License"); you may not use this file except in compliance with
7  *  the License.  You may obtain a copy of the License at
8  *
9  *      http://www.apache.org/licenses/LICENSE-2.0
10  *
11  *  Unless required by applicable law or agreed to in writing, software
12  *  distributed under the License is distributed on an "AS IS" BASIS,
13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  *  See the License for the specific language governing permissions and
15  *  limitations under the License.
16  *
17  */
18 
19 package org.apache.commons.compress.archivers.zip;
20 
21 /**
22  * Info-ZIP Unicode Comment Extra Field (0x6375):
23  *
24  * <p>Stores the UTF-8 version of the file comment as stored in the
25  * central directory header.</p>
26  *
27  * @see <a href="https://www.pkware.com/documents/casestudies/APPNOTE.TXT">PKWARE
28  * APPNOTE.TXT, section 4.6.8</a>
29  *
30  * @NotThreadSafe super-class is not thread-safe
31  */
32 public class UnicodeCommentExtraField extends AbstractUnicodeExtraField {
33 
34     public static final ZipShort UCOM_ID = new ZipShort(0x6375);
35 
UnicodeCommentExtraField()36     public UnicodeCommentExtraField () {
37     }
38 
39     /**
40      * Assemble as unicode comment extension from the name given as
41      * text as well as the encoded bytes actually written to the archive.
42      *
43      * @param text The file name
44      * @param bytes the bytes actually written to the archive
45      * @param off The offset of the encoded comment in <code>bytes</code>.
46      * @param len The length of the encoded comment or comment in
47      * <code>bytes</code>.
48      */
UnicodeCommentExtraField(final String text, final byte[] bytes, final int off, final int len)49     public UnicodeCommentExtraField(final String text, final byte[] bytes, final int off,
50                                     final int len) {
51         super(text, bytes, off, len);
52     }
53 
54     /**
55      * Assemble as unicode comment extension from the comment given as
56      * text as well as the bytes actually written to the archive.
57      *
58      * @param comment The file comment
59      * @param bytes the bytes actually written to the archive
60      */
UnicodeCommentExtraField(final String comment, final byte[] bytes)61     public UnicodeCommentExtraField(final String comment, final byte[] bytes) {
62         super(comment, bytes);
63     }
64 
65     @Override
getHeaderId()66     public ZipShort getHeaderId() {
67         return UCOM_ID;
68     }
69 
70 }
71