org.sejda.sambox.pdmodel.common.COSDictionaryMap Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sambox Show documentation
Show all versions of sambox Show documentation
An Apache PDFBox fork intended to be used as PDF processor for Sejda and PDFsam
related projects
/*
* 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.sejda.sambox.pdmodel.common;
import java.io.IOException;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import org.sejda.sambox.cos.COSBase;
import org.sejda.sambox.cos.COSBoolean;
import org.sejda.sambox.cos.COSDictionary;
import org.sejda.sambox.cos.COSFloat;
import org.sejda.sambox.cos.COSInteger;
import org.sejda.sambox.cos.COSName;
import org.sejda.sambox.cos.COSObjectable;
import org.sejda.sambox.cos.COSString;
/**
* This is a Map that will automatically sync the contents to a COSDictionary.
*
* @author Ben Litchfield
*/
public class COSDictionaryMap implements Map
{
private final COSDictionary map;
private final Map actuals;
/**
* Constructor for this map.
*
* @param actualsMap The map with standard java objects as values.
* @param dicMap The map with COSBase objects as values.
*/
public COSDictionaryMap(Map actualsMap, COSDictionary dicMap)
{
actuals = actualsMap;
map = dicMap;
}
/**
* {@inheritDoc}
*/
@Override
public int size()
{
return map.size();
}
/**
* {@inheritDoc}
*/
@Override
public boolean isEmpty()
{
return size() == 0;
}
/**
* {@inheritDoc}
*/
@Override
public boolean containsKey(Object key)
{
return actuals.containsKey(key);
}
/**
* {@inheritDoc}
*/
@Override
public boolean containsValue(Object value)
{
return actuals.containsValue(value);
}
/**
* {@inheritDoc}
*/
@Override
public V get(Object key)
{
return actuals.get(key);
}
/**
* {@inheritDoc}
*/
@Override
public V put(K key, V value)
{
COSObjectable object = (COSObjectable) value;
map.setItem(COSName.getPDFName((String) key), object.getCOSObject());
return actuals.put(key, value);
}
/**
* {@inheritDoc}
*/
@Override
public V remove(Object key)
{
map.removeItem(COSName.getPDFName((String) key));
return actuals.remove(key);
}
/**
* {@inheritDoc}
*/
@Override
public void putAll(Map t)
{
throw new UnsupportedOperationException("Not yet implemented");
}
/**
* {@inheritDoc}
*/
@Override
public void clear()
{
map.clear();
actuals.clear();
}
/**
* {@inheritDoc}
*/
@Override
public Set keySet()
{
return actuals.keySet();
}
/**
* {@inheritDoc}
*/
@Override
public Collection values()
{
return actuals.values();
}
/**
* {@inheritDoc}
*/
@Override
public Set> entrySet()
{
return Collections.unmodifiableSet(actuals.entrySet());
}
/**
* {@inheritDoc}
*/
@Override
public boolean equals(Object o)
{
if (o instanceof COSDictionaryMap other)
{
return other.map.equals(this.map);
}
return false;
}
/**
* {@inheritDoc}
*/
@Override
public String toString()
{
return actuals.toString();
}
/**
* {@inheritDoc}
*/
@Override
public int hashCode()
{
return map.hashCode();
}
/**
* This will take a map<String,COSObjectable> and convert it into a COSDictionary.
*
* @param someMap A map containing COSObjectables
*
* @return A proper COSDictionary
*/
public static COSDictionary convert(Map someMap)
{
COSDictionary dic = new COSDictionary();
for (Entry entry : someMap.entrySet())
{
String name = entry.getKey();
COSObjectable object = (COSObjectable) entry.getValue();
dic.setItem(COSName.getPDFName(name), object.getCOSObject());
}
return dic;
}
/**
* This will take a COS dictionary and convert it into COSDictionaryMap. All cos objects will be converted to their
* primitive form.
*
* @param map The COS mappings.
* @return A standard java map.
* @throws IOException If there is an error during the conversion.
*/
public static COSDictionaryMap convertBasicTypesToMap(COSDictionary map)
throws IOException
{
COSDictionaryMap retval = null;
if (map != null)
{
Map actualMap = new HashMap<>();
for (COSName key : map.keySet())
{
COSBase cosObj = map.getDictionaryObject(key);
Object actualObject = null;
if (cosObj instanceof COSString)
{
actualObject = ((COSString) cosObj).getString();
}
else if (cosObj instanceof COSInteger)
{
actualObject = ((COSInteger) cosObj).intValue();
}
else if (cosObj instanceof COSName)
{
actualObject = ((COSName) cosObj).getName();
}
else if (cosObj instanceof COSFloat)
{
actualObject = ((COSFloat) cosObj).floatValue();
}
else if (cosObj instanceof COSBoolean)
{
actualObject = ((COSBoolean) cosObj).getValue() ? Boolean.TRUE : Boolean.FALSE;
}
else
{
throw new IOException("Error:unknown type of object to convert:" + cosObj);
}
actualMap.put(key.getName(), actualObject);
}
retval = new COSDictionaryMap<>(actualMap, map);
}
return retval;
}
}