org.mapstruct.ap.spi.MapStructProcessingEnvironment Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mapstruct-processor Show documentation

An annotation processor for generating type-safe bean mappers

There is a newer version: 1.6.3

/*
 * Copyright MapStruct Authors.
 *
 * Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
 */
package org.mapstruct.ap.spi;

import javax.lang.model.util.Elements;
import javax.lang.model.util.Types;
import java.util.Map;

/**
 * MapStruct will provide the implementations of its SPIs with on object implementing this interface so they can use
 * facilities provided by it. It is a subset of {@link javax.annotation.processing.ProcessingEnvironment
 * ProcessingEnvironment}.
 *
 * @author Filip Hrisafov
 * @see javax.annotation.processing.ProcessingEnvironment
 *
 * @since 1.3
 */
public interface MapStructProcessingEnvironment {

    /**
     * Returns an implementation of some utility methods for
     * operating on elements
     *
     * @return element utilities
     */
    Elements getElementUtils();

    /**
     * Returns an implementation of some utility methods for
     * operating on types.
     *
     * @return type utilities
     */
    Types getTypeUtils();

    /**
     * Returns the resolved options specified by the impl of
     * {@link AdditionalSupportedOptionsProvider}.
     *
     * @return resolved options
     */
    Map getOptions();

}