/*
* 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.cos;
import org.apache.pdfbox.exceptions.COSVisitorException;
import java.io.IOException;
/**
* This class represents a PDF object.
*
* @author <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a>
* @version $Revision: 1.37 $
*/
public class COSObject extends COSBase
{
private COSBase baseObject;
private COSInteger objectNumber;
private COSInteger generationNumber;
/**
* Constructor.
*
* @param object The object that this encapsulates.
*
* @throws IOException If there is an error with the object passed in.
*/
public COSObject( COSBase object ) throws IOException
{
setObject( object );
}
/**
* This will get the dictionary object in this object that has the name key and
* if it is a pdfobjref then it will dereference that and return it.
*
* @param key The key to the value that we are searching for.
*
* @return The pdf object that matches the key.
*/
public COSBase getDictionaryObject( COSName key )
{
COSBase retval =null;
if( baseObject instanceof COSDictionary )
{
retval = ((COSDictionary)baseObject).getDictionaryObject( key );
}
return retval;
}
/**
* This will get the dictionary object in this object that has the name key.
*
* @param key The key to the value that we are searching for.
*
* @return The pdf object that matches the key.
*/
public COSBase getItem( COSName key )
{
COSBase retval =null;
if( baseObject instanceof COSDictionary )
{
retval = ((COSDictionary)baseObject).getItem( key );
}
return retval;
}
/**
* This will get the object that this object encapsulates.
*
* @return The encapsulated object.
*/
public COSBase getObject()
{
return baseObject;
}
/**
* This will set the object that this object encapsulates.
*
* @param object The new object to encapsulate.
*
* @throws IOException If there is an error setting the updated object.
*/
public void setObject( COSBase object ) throws IOException
{
baseObject = object;
/*if( baseObject == null )
{
baseObject = object;
}
else
{
//This is for when an object appears twice in the
//pdf file we really want to replace it such that
//object references still work correctly.
//see owcp-as-received.pdf for an example
if( baseObject instanceof COSDictionary )
{
COSDictionary dic = (COSDictionary)baseObject;
COSDictionary dicObject = (COSDictionary)object;
dic.clear();
dic.addAll( dicObject );
}
else if( baseObject instanceof COSArray )
{
COSArray array = (COSArray)baseObject;
COSArray arrObject = (COSArray)object;
array.clear();
for( int i=0; i<arrObject.size(); i++ )
{
array.add( arrObject.get( i ) );
}
}
else if( baseObject instanceof COSStream )
{
COSStream oldStream = (COSStream)baseObject;
System.out.println( "object:" + object.getClass().getName() );
COSStream newStream = (COSStream)object;
oldStream.replaceWithStream( newStream );
}
else if( baseObject instanceof COSInteger )
{
COSInteger oldInt = (COSInteger)baseObject;
COSInteger newInt = (COSInteger)object;
oldInt.setValue( newInt.longValue() );
}
else if( baseObject == null )
{
baseObject = object;
}
else
{
throw new IOException( "Unknown object substitution type:" + baseObject );
}
}*/
}
/**
* {@inheritDoc}
*/
public String toString()
{
return "COSObject{" +
(objectNumber == null ? "unknown" : "" + objectNumber.intValue() ) + ", " +
(generationNumber == null ? "unknown" : "" + generationNumber.intValue() ) +
"}";
}
/** Getter for property objectNumber.
* @return Value of property objectNumber.
*/
public COSInteger getObjectNumber()
{
return objectNumber;
}
/** Setter for property objectNumber.
* @param objectNum New value of property objectNumber.
*/
public void setObjectNumber(COSInteger objectNum)
{
objectNumber = objectNum;
}
/** Getter for property generationNumber.
* @return Value of property generationNumber.
*/
public COSInteger getGenerationNumber()
{
return generationNumber;
}
/** Setter for property generationNumber.
* @param generationNumberValue New value of property generationNumber.
*/
public void setGenerationNumber(COSInteger generationNumberValue)
{
generationNumber = generationNumberValue;
}
/**
* visitor pattern double dispatch method.
*
* @param visitor The object to notify when visiting this object.
* @return any object, depending on the visitor implementation, or null
* @throws COSVisitorException If an error occurs while visiting this object.
*/
public Object accept( ICOSVisitor visitor ) throws COSVisitorException
{
return getObject() != null ? getObject().accept( visitor ) : COSNull.NULL.accept( visitor );
}
}