org.apache.pdfbox.debugger.ui.MapEntry Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of pdfbox-debugger Show documentation

The Apache PDFBox library is an open source Java tool for working with PDF documents. This artefact contains the PDFDebugger.

The newest version!

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.pdfbox.debugger.ui;

import org.apache.pdfbox.cos.COSBase;
import org.apache.pdfbox.cos.COSName;


/**
 * This is a simple class that will contain a key and a value.
 *
 * @author Ben Litchfield
 */
public class MapEntry
{
    private COSName key;
    private COSBase value;
    private COSBase item;

    /**
     * Get the key for this entry.
     *
     * @return The entry's key.
     */
    public COSName getKey()
    {
        return key;
    }

    /**
     * This will set the key for this entry.
     *
     * @param k the new key for this entry.
     */
    public void setKey(COSName k)
    {
        key = k;
    }

    /**
     * This will get the value for this entry.
     *
     * @return The value for this entry.
     */
    public COSBase getValue()
    {
        return value;
    }

    /**
     * This will get the value for this entry.
     *
     * @return The value for this entry.
     */
    public COSBase getItem()
    {
        return item;
    }

    /**
     * This will set the value for this entry.
     *
     * @param val the new value for this entry.
     */
    public void setValue(COSBase val)
    {
        this.value = val;
    }

    /**
     * This will set the value for this entry.
     *
     * @param val the new value for this entry.
     */
    public void setItem(COSBase val)
    {
        this.item = val;
    }

    /**
     * This will output a string representation of this class.
     *
     * @return A string representation of this class.
     */
    @Override
    public String toString()
    {
        if (key != null)
        {
            return key.getName();
        }
        return "(null)";
    }
}