org.apache.pdfbox.preflight.action.GoToAction Maven / Gradle / Ivy
/*****************************************************************************
*
* 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.preflight.action;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_ACTION_MISING_KEY;
import org.apache.pdfbox.cos.COSBase;
import org.apache.pdfbox.cos.COSDictionary;
import org.apache.pdfbox.cos.COSName;
import static org.apache.pdfbox.preflight.PreflightConfiguration.DESTINATION_PROCESS;
import org.apache.pdfbox.preflight.PreflightContext;
import org.apache.pdfbox.preflight.ValidationResult.ValidationError;
import org.apache.pdfbox.preflight.exception.ValidationException;
import org.apache.pdfbox.preflight.utils.ContextHelper;
/**
* ActionManager for the GoTo action. GoToAction is valid if the D entry is present.
*/
public class GoToAction extends AbstractActionManager
{
/**
*
* @param amFact Instance of ActionManagerFactory used to create ActionManager to check Next actions.
* @param adict the COSDictionary of the action wrapped by this class.
* @param ctx the preflight context.
* @param aaKey the name of the key which identifies the action in an additional action dictionary.
*/
public GoToAction(ActionManagerFactory amFact, COSDictionary adict, PreflightContext ctx, String aaKey)
{
super(amFact, adict, ctx, aaKey);
}
/*
* (non-Javadoc)
*
* @see AbstractActionManager#valid(java.util.List)
*/
@Override
protected boolean innerValid() throws ValidationException
{
COSBase dest = this.actionDictionary.getItem(COSName.D);
// ---- D entry is mandatory
if (dest == null)
{
context.addValidationError(new ValidationError(ERROR_ACTION_MISING_KEY,
"D entry is mandatory for the GoToActions"));
return false;
}
ContextHelper.validateElement(context, dest, DESTINATION_PROCESS);
return true;
}
}