org.immutables.extgenerator.GeneratedImportsModifier Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of value Show documentation

Compile time annotations and compile time annotation processor to generate consistent value object using either abstract class, interface or annotation as a base.

There is a newer version: 2.10.1

Show newest version

/*
   Copyright 2016 Immutables Authors and Contributors

   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 org.immutables.extgenerator;

import java.util.ServiceLoader;
import java.util.Set;

/**
 * Ad-hoc tool to change imports in generated source files after imports have been processed.
 * The annotation processor with load implementations of this
 * interface using classpath service loading, see {@link ServiceLoader} for the details.
 * Make sure it will be present of the annotation processor classpath rather than compile classpath
 * if they are not the same in your build tool. Implementations should take special care of safety,
 * i.e. they should neither throw exception during construction or processing nor leave set of
 * imports in an improperly modified state.
 * @since 2.1
 */
public interface GeneratedImportsModifier {
  /**
   * Modify imports set after import processing/extraction but before writing generated files.
   * Important to note that there are no way to change classnames as other parts of source file
   * refers to class by simple name. However package-name part of imports may be rewritten.
   * @param packageOfGeneratedFile informative package name of the generated file, may be used to
   *          employ different strategies for different packages.
   * @param imports modifiables set of imports
   */
  void modify(String packageOfGeneratedFile, Set imports);
}