Package org.sonatype.maven.polyglot.mapping

Interface Mapping

    • Method Detail

      • locatePom

        java.io.File locatePom​(java.io.File dir)
        Locates the pom in the given directory
        Parameters:
        dir - the directory to locate the pom for
        Returns:
        the located pom or null if none was found by this mapping

      • accept

        boolean accept​(java.util.Map<java.lang.String,​?> options)
        Tests weather this mapping accepts the given option
        Parameters:
        options - the options to use
        Returns:
        true if options are accepted, false otherwise

      • getReader

        org.apache.maven.model.io.ModelReader getReader()
        Returns:
        the ModelReader responsible for reading poms returned by the locatePom(File) method

      • getWriter

        org.apache.maven.model.io.ModelWriter getWriter()
        Returns:
        the ModelWriter responsible for writing poms returned by the locatePom(File) method

      • getPriority

        float getPriority()
        get the priority of this mapping, higher priorities are given precedence over those with lower priority, the default priority is 0
        Returns:
        the priority

      • getFlavour

        java.lang.String getFlavour()
        Returns:
        the flavor used to identify this mapping (e.g. xml, json, yaml, ...)

      • getEnhancementProperties

        default java.util.Properties getEnhancementProperties​(java.util.Map<java.lang.String,​?> options)
        A properties object can enhance the returned polyglot model by e.g. a user defined file read by the mapping, supported keys are other keys are possible but will be silently ignored. If a property starts with PROPERTY_PREFIX it will be interpreted as an enhancement to the properties of the model by removing the prefix and using its value as-is.
        Returns:
        a properties object that enhances the the generated model (e.g. by a user provided file) or null if no properties exits