org.apache.pdfbox.cos.COSBase Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pdfbox Show documentation
Show all versions of pdfbox Show documentation
The Apache PDFBox library is an open source Java tool for working with PDF documents.
/*
* 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.filter.FilterManager;
import org.apache.pdfbox.pdmodel.common.COSObjectable;
import org.apache.pdfbox.exceptions.COSVisitorException;
/**
* The base object that all objects in the PDF document will extend.
*
* @author Ben Litchfield
* @version $Revision: 1.14 $
*/
public abstract class COSBase implements COSObjectable
{
/**
* Constructor.
*/
private boolean needToBeUpdate;
private boolean direct;
public COSBase()
{
needToBeUpdate = false;
}
/**
* This will get the filter manager to use to filter streams.
*
* @return The filter manager.
*/
public FilterManager getFilterManager()
{
/**
* @todo move this to PDFdocument or something better
*/
return new FilterManager();
}
/**
* Convert this standard java object to a COS object.
*
* @return The cos object that matches this Java object.
*/
public COSBase getCOSObject()
{
return this;
}
/**
* 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 abstract Object accept(ICOSVisitor visitor) throws COSVisitorException;
public void setNeedToBeUpdate(boolean flag)
{
needToBeUpdate = flag;
}
/**
* If the state is set true, the dictionary will be written direct into the called object.
* This means, no indirect object will be created.
*
* @return the state
*/
public boolean isDirect()
{
return direct;
}
/**
* Set the state true, if the dictionary should be written as a direct object and not indirect.
*
* @param direct set it true, for writing direct object
*/
public void setDirect(boolean direct)
{
this.direct = direct;
}
public boolean isNeedToBeUpdate()
{
return needToBeUpdate;
}
}