001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.imaging.formats.jpeg.iptc;
018
019import java.util.Objects;
020
021/**
022 * Represents an IPTC block, a set of key-value pairs of Photoshop IPTC data.
023 * <p>
024 * The class is used in public API parameter types.
025 * </p>
026 */
027public class IptcBlock {
028
029    private final int blockType;
030    private final byte[] blockNameBytes;
031    private final byte[] blockData;
032
033    public IptcBlock(final int blockType, final byte[] blockNameBytes, final byte[] blockData) {
034        this.blockData = Objects.requireNonNull(blockData, "blockData");
035        this.blockNameBytes = Objects.requireNonNull(blockNameBytes, "blockNameBytes");
036        this.blockType = blockType;
037    }
038
039    public byte[] getBlockData() {
040        return blockData.clone();
041    }
042
043    public byte[] getBlockNameBytes() {
044        return blockNameBytes.clone();
045    }
046
047    public int getBlockType() {
048        return blockType;
049    }
050
051    public boolean isIptcBlock() {
052        return blockType == IptcConstants.IMAGE_RESOURCE_BLOCK_IPTC_DATA;
053    }
054}