Package org.apache.maven.model.building

Class DefaultModelProcessor

  • All Implemented Interfaces:
    ModelProcessor, ModelReader, ModelLocator
    @Named("core-default")
@Singleton
@Typed(ModelProcessor.class)
public class DefaultModelProcessor
extends Object
implements ModelProcessor
    Note: uses @Typed to limit the types it is available for injection to just ModelProcessor. This is because the ModelProcessor interface extends ModelLocator and ModelReader. If we made this component available under all its interfaces then it could end up being injected into itself leading to a stack overflow. A side-effect of using @Typed is that it translates to explicit bindings in the container. So instead of binding the component under a 'wildcard' key it is now bound with an explicit key. Since this is a default component this will be a plain binding of ModelProcessor to this implementation type, ie. no hint/name. This leads to a second side-effect in that any @Inject request for just ModelProcessor in the same injector is immediately matched to this explicit binding, which means extensions cannot override this binding. This is because the lookup is always short-circuited in this specific situation (plain @Inject request, and plain explicit binding for the same type.) The simplest solution is to use a custom @Named here so it isn't bound under the plain key. This is only necessary for default components using @Typed that want to support overriding. As a non-default component this now gets a negative priority relative to other implementations of the same interface. Since we want to allow overriding this doesn't matter in this case. (if it did we could add @Priority of 0 to match the priority given to default components.)

    • Constructor Detail

      • DefaultModelProcessor

        public DefaultModelProcessor()

    • Method Detail

      • locatePom

        public File locatePom​(File projectDirectory)
        Description copied from interface: ModelLocator
        Locates the POM file within the specified project directory. In case the given project directory does not exist or does not contain a POM file, the return value indicates the expected path to the POM file. Sub directories of the project directory will not be considered when locating the POM file. The return value will be an absolute path if the project directory is given as an absolute path.
        Specified by:
        locatePom in interface ModelLocator
        Parameters:
        projectDirectory - The (possibly non-existent) base directory to locate the POM file in, must not be null.
        Returns:
        The path to the (possibly non-existent) POM file, never null.

      • read

        public Model read​(File input,
                  Map<String,​?> options)
           throws IOException
        Description copied from interface: ModelReader
        Reads the model from the specified file.
        Specified by:
        read in interface ModelReader
        Parameters:
        input - The file to deserialize the model from, must not be null.
        options - The options to use for deserialization, may be null to use the default values.
        Returns:
        The deserialized model, never null.
        Throws:
        IOException - If the model could not be deserialized.
        ModelParseException - If the input format could not be parsed.

      • read

        public Model read​(Reader input,
                  Map<String,​?> options)
           throws IOException
        Description copied from interface: ModelReader
        Reads the model from the specified character reader. The reader will be automatically closed before the method returns.
        Specified by:
        read in interface ModelReader
        Parameters:
        input - The reader to deserialize the model from, must not be null.
        options - The options to use for deserialization, may be null to use the default values.
        Returns:
        The deserialized model, never null.
        Throws:
        IOException - If the model could not be deserialized.
        ModelParseException - If the input format could not be parsed.

      • read

        public Model read​(InputStream input,
                  Map<String,​?> options)
           throws IOException
        Description copied from interface: ModelReader
        Reads the model from the specified byte stream. The stream will be automatically closed before the method returns.
        Specified by:
        read in interface ModelReader
        Parameters:
        input - The stream to deserialize the model from, must not be null.
        options - The options to use for deserialization, may be null to use the default values.
        Returns:
        The deserialized model, never null.
        Throws:
        IOException - If the model could not be deserialized.
        ModelParseException - If the input format could not be parsed.