View Javadoc
1   /*
2    * GordianKnot: Security Suite
3    * Copyright 2012-2026. Tony Washer
4    *
5    * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6    * use this file except in compliance with the License.  You may obtain a copy
7    * 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, WITHOUT
13   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
14   * License for the specific language governing permissions and limitations under
15   * the License.
16   */
17  package io.github.tonywasher.joceanus.gordianknot.api.zip;
18  
19  /**
20   * GordianKnot File Entry API.
21   */
22  public interface GordianZipFileEntry {
23      /**
24       * Obtain the name of the file.
25       *
26       * @return the name of the file
27       */
28      String getFileName();
29  
30      /**
31       * Set User String property.
32       *
33       * @param pPropertyName  the property name
34       * @param pPropertyValue the property value
35       */
36      void setUserStringProperty(String pPropertyName,
37                                 String pPropertyValue);
38  
39      /**
40       * Set User Long property.
41       *
42       * @param pPropertyName  the property name
43       * @param pPropertyValue the property value
44       */
45      void setUserLongProperty(String pPropertyName,
46                               Long pPropertyValue);
47  
48      /**
49       * Get User String property.
50       *
51       * @param pPropertyName the property name
52       * @return the property value (or null)
53       */
54      String getUserStringProperty(String pPropertyName);
55  
56      /**
57       * Get User Long property.
58       *
59       * @param pPropertyName the property name
60       * @return the property value (or null)
61       */
62      Long getUserLongProperty(String pPropertyName);
63  }