/*
* 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.persistence.util;
import org.apache.pdfbox.cos.COSObject;
/**
* Object representing the physical reference to an indirect pdf object.
*
* @author Michael Traut
* @version $Revision: 1.5 $
*/
public class COSObjectKey implements Comparable<COSObjectKey>
{
private long number;
private long generation;
/**
* PDFObjectKey constructor comment.
*
* @param object The object that this key will represent.
*/
public COSObjectKey(COSObject object)
{
this( object.getObjectNumber().longValue(), object.getGenerationNumber().longValue() );
}
/**
* PDFObjectKey constructor comment.
*
* @param num The object number.
* @param gen The object generation number.
*/
public COSObjectKey(long num, long gen)
{
setNumber(num);
setGeneration(gen);
}
/**
* {@inheritDoc}
*/
public boolean equals(Object obj)
{
return (obj instanceof COSObjectKey) &&
((COSObjectKey)obj).getNumber() == getNumber() &&
((COSObjectKey)obj).getGeneration() == getGeneration();
}
/**
* This will get the generation number.
*
* @return The objects generation number.
*/
public long getGeneration()
{
return generation;
}
/**
* This will get the objects id.
*
* @return The object's id.
*/
public long getNumber()
{
return number;
}
/**
* {@inheritDoc}
*/
public int hashCode()
{
return (int)(number + generation);
}
/**
* This will set the objects generation number.
*
* @param newGeneration The objects generation number.
*/
public void setGeneration(long newGeneration)
{
generation = newGeneration;
}
/**
* This will set the objects id.
*
* @param newNumber The objects number.
*/
public void setNumber(long newNumber)
{
number = newNumber;
}
/**
* {@inheritDoc}
*/
public String toString()
{
return "" + getNumber() + " " + getGeneration() + " R";
}
/** {@inheritDoc} */
public int compareTo(COSObjectKey other)
{
if (getNumber() < other.getNumber())
{
return -1;
}
else if (getNumber() > other.getNumber())
{
return 1;
}
else
{
if (getGeneration() < other.getGeneration())
{
return -1;
}
else if (getGeneration() > other.getGeneration())
{
return 1;
}
else
{
return 0;
}
}
}
}