org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.Revisions 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.pdmodel.documentinterchange.logicalstructure;
import java.util.ArrayList;
import java.util.List;
/**
*
* @author Koch
* @version $Revision: $
*
* @param the type of object to store the revision numbers with
*/
public class Revisions
{
private List objects;
private List revisionNumbers;
private List getObjects()
{
if (this.objects == null)
{
this.objects = new ArrayList();
}
return this.objects;
}
private List getRevisionNumbers()
{
if (this.revisionNumbers == null)
{
this.revisionNumbers = new ArrayList();
}
return this.revisionNumbers;
}
/**
*
*/
public Revisions()
{
}
/**
* Returns the object at the specified position.
*
* @param index the position
* @return the object
* @throws IndexOutOfBoundsException if the index is out of range
*/
public T getObject(int index) throws IndexOutOfBoundsException
{
return this.getObjects().get(index);
}
/**
* Returns the revision number at the specified position.
*
* @param index the position
* @return the revision number
* @throws IndexOutOfBoundsException if the index is out of range
*/
public int getRevisionNumber(int index) throws IndexOutOfBoundsException
{
return this.getRevisionNumbers().get(index);
}
/**
* Adds an object with a specified revision number.
*
* @param object the object
* @param revisionNumber the revision number
*/
public void addObject(T object, int revisionNumber)
{
this.getObjects().add(object);
this.getRevisionNumbers().add(revisionNumber);
}
/**
* Sets the revision number of a specified object.
*
* @param object the object
* @param revisionNumber the revision number
*/
protected void setRevisionNumber(T object, int revisionNumber)
{
int index = this.getObjects().indexOf(object);
if (index > -1)
{
this.getRevisionNumbers().set(index, revisionNumber);
}
}
/**
* Returns the size.
*
* @return the size
*/
public int size()
{
return this.getObjects().size();
}
/**
* {@inheritDoc}
*/
public String toString()
{
StringBuilder sb = new StringBuilder();
for (int i = 0; i < this.getObjects().size(); i++)
{
if (i > 0)
{
sb.append("; ");
}
sb.append("object=").append(this.getObjects().get(i))
.append(", revisionNumber=").append(this.getRevisionNumber(i));
}
return sb.toString();
}
}