Debian Codegraph @

src/main/java/org/apache/tools/zip/UnicodeCommentExtraField.java

raw
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.tools.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 * <pre>
28 * Value Size Description
29 * ----- ---- -----------
30 * (UCom) 0x6375 Short tag for this extra block type ("uc")
31 * TSize Short total data size for this block
32 * Version 1 byte version of this extra field, currently 1
33 * ComCRC32 4 bytes Comment Field CRC32 Checksum
34 * UnicodeCom Variable UTF-8 version of the entry comment
35 * </pre>
36 */
37 public class UnicodeCommentExtraField extends AbstractUnicodeExtraField {
38
39 public static final ZipShort UCOM_ID = new ZipShort(0x6375);
40
41 public UnicodeCommentExtraField () {
42 }
43
44 /**
45 * Assemble as unicode comment extension from the name given as
46 * text as well as the encoded bytes actually written to the archive.
47 *
48 * @param text The file name
49 * @param bytes the bytes actually written to the archive
50 * @param off The offset of the encoded comment in <code>bytes</code>.
51 * @param len The length of the encoded comment or comment in
52 * <code>bytes</code>.
53 */
54 public UnicodeCommentExtraField(String text, byte[] bytes, int off,
55 int len) {
56 super(text, bytes, off, len);
57 }
58
59 /**
60 * Assemble as unicode comment extension from the comment given as
61 * text as well as the bytes actually written to the archive.
62 *
63 * @param comment The file comment
64 * @param bytes the bytes actually written to the archive
65 */
66 public UnicodeCommentExtraField(String comment, byte[] bytes) {
67 super(comment, bytes);
68 }
69
70 public ZipShort getHeaderId() {
71 return UCOM_ID;
72 }
73
74 }