View Javadoc
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  package org.apache.commons.imaging.formats.jpeg.iptc;
18  
19  import java.util.Objects;
20  
21  /**
22   * Represents an IPTC block, a set of key-value pairs of Photoshop IPTC data.
23   * <p>
24   * The class is used in public API parameter types.
25   * </p>
26   */
27  public class IptcBlock {
28  
29      private final int blockType;
30      private final byte[] blockNameBytes;
31      private final byte[] blockData;
32  
33      public IptcBlock(final int blockType, final byte[] blockNameBytes, final byte[] blockData) {
34          this.blockData = Objects.requireNonNull(blockData, "blockData");
35          this.blockNameBytes = Objects.requireNonNull(blockNameBytes, "blockNameBytes");
36          this.blockType = blockType;
37      }
38  
39      public byte[] getBlockData() {
40          return blockData.clone();
41      }
42  
43      public byte[] getBlockNameBytes() {
44          return blockNameBytes.clone();
45      }
46  
47      public int getBlockType() {
48          return blockType;
49      }
50  
51      public boolean isIptcBlock() {
52          return blockType == IptcConstants.IMAGE_RESOURCE_BLOCK_IPTC_DATA;
53      }
54  }