com.helger.pdflayout4.base.IPLVisitable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-pdf-layout4 Show documentation

Library for creating nicely layouted PDF documents based on PDFBox

The newest version!

/*
 * Copyright (C) 2014-2021 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed 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 com.helger.pdflayout4.base;

import java.io.IOException;

import javax.annotation.Nonnull;

import com.helger.commons.state.EChange;

/**
 * Base interface for visitable objects.
 *
 * @author Philip Helger
 */
public interface IPLVisitable
{
  /**
   * Visit this object and all descendants
   *
   * @param aVisitor
   *        The visitor to use. May not be null.
   * @return {@link EChange#CHANGED} if something changed internally.
   * @throws IOException
   *         on PDFBox error
   */
  @Nonnull
  EChange visit (@Nonnull IPLVisitor aVisitor) throws IOException;
}