Class Options


  • public class Options
    extends java.lang.Object
    • Field Detail

      • LOGGER

        private static final java.util.logging.Logger LOGGER
      • outputOnlyModifications

        private boolean outputOnlyModifications
      • outputOnlyBinaryIncompatibleModifications

        private boolean outputOnlyBinaryIncompatibleModifications
      • xmlOutputFile

        private Optional<java.lang.String> xmlOutputFile
      • htmlOutputFile

        private Optional<java.lang.String> htmlOutputFile
      • includes

        private java.util.List<Filter> includes
      • excludes

        private java.util.List<Filter> excludes
      • includeSynthetic

        private boolean includeSynthetic
      • htmlStylesheet

        private Optional<java.lang.String> htmlStylesheet
      • oldClassPath

        private Optional<java.lang.String> oldClassPath
      • newClassPath

        private Optional<java.lang.String> newClassPath
      • noAnnotations

        private boolean noAnnotations
      • reportOnlyFilename

        private boolean reportOnlyFilename
      • semanticVersioning

        private boolean semanticVersioning
      • errorOnBinaryIncompatibility

        private boolean errorOnBinaryIncompatibility
      • errorOnSourceIncompatibility

        private boolean errorOnSourceIncompatibility
      • errorOnExclusionIncompatibility

        private boolean errorOnExclusionIncompatibility
      • errorOnModifications

        private boolean errorOnModifications
      • errorOnSemanticIncompatibility

        private boolean errorOnSemanticIncompatibility
      • ignoreMissingOldVersion

        private boolean ignoreMissingOldVersion
      • ignoreMissingNewVersion

        private boolean ignoreMissingNewVersion
      • helpRequested

        private boolean helpRequested
      • errorOnSemanticIncompatibilityForMajorVersionZero

        private boolean errorOnSemanticIncompatibilityForMajorVersionZero
    • Constructor Detail

      • Options

        Options()
    • Method Detail

      • newDefault

        public static Options newDefault()
      • verify

        public void verify()
      • verifyExistsCanReadAndJar

        private static void verifyExistsCanReadAndJar​(JApiCmpArchive jApiCmpArchive)
      • verifyExisting

        private static void verifyExisting​(JApiCmpArchive jApiCmpArchive)
      • verifyCanRead

        private static void verifyCanRead​(JApiCmpArchive jApiCmpArchive)
      • verifyJarArchive

        private static void verifyJarArchive​(JApiCmpArchive jApiCmpArchive)
      • getNewArchives

        public java.util.List<JApiCmpArchive> getNewArchives()
      • setNewArchives

        public void setNewArchives​(java.util.List<JApiCmpArchive> newArchives)
      • getOldArchives

        public java.util.List<JApiCmpArchive> getOldArchives()
      • setOldArchives

        public void setOldArchives​(java.util.List<JApiCmpArchive> oldArchives)
      • isOutputOnlyModifications

        public boolean isOutputOnlyModifications()
      • setOutputOnlyModifications

        public void setOutputOnlyModifications​(boolean outputOnlyModifications)
      • getXmlOutputFile

        public Optional<java.lang.String> getXmlOutputFile()
      • setXmlOutputFile

        public void setXmlOutputFile​(Optional<java.lang.String> xmlOutputFile)
      • setAccessModifier

        public void setAccessModifier​(AccessModifier accessModifier)
      • getIncludes

        public java.util.List<Filter> getIncludes()
      • getExcludes

        public java.util.List<Filter> getExcludes()
      • addExcludeFromArgument

        public void addExcludeFromArgument​(Optional<java.lang.String> packagesExcludeArg,
                                           boolean excludeExclusively)
      • addIncludeFromArgument

        public void addIncludeFromArgument​(Optional<java.lang.String> packagesIncludeArg,
                                           boolean includeExclusively)
      • createFilterList

        public java.util.List<Filter> createFilterList​(Optional<java.lang.String> argumentString,
                                                       java.util.List<Filter> filters,
                                                       java.lang.String errorMessage,
                                                       boolean exclusive)
      • isOutputOnlyBinaryIncompatibleModifications

        public boolean isOutputOnlyBinaryIncompatibleModifications()
      • setOutputOnlyBinaryIncompatibleModifications

        public void setOutputOnlyBinaryIncompatibleModifications​(boolean outputOnlyBinaryIncompatibleModifications)
      • getHtmlOutputFile

        public Optional<java.lang.String> getHtmlOutputFile()
      • setHtmlOutputFile

        public void setHtmlOutputFile​(Optional<java.lang.String> htmlOutputFile)
      • isIncludeSynthetic

        public boolean isIncludeSynthetic()
      • setIncludeSynthetic

        public void setIncludeSynthetic​(boolean showSynthetic)
      • setIgnoreMissingClasses

        public void setIgnoreMissingClasses​(boolean ignoreMissingClasses)
      • getHtmlStylesheet

        public Optional<java.lang.String> getHtmlStylesheet()
      • setHtmlStylesheet

        public void setHtmlStylesheet​(Optional<java.lang.String> htmlStylesheet)
      • getOldClassPath

        public Optional<java.lang.String> getOldClassPath()
      • setOldClassPath

        public void setOldClassPath​(Optional<java.lang.String> oldClassPath)
      • getNewClassPath

        public Optional<java.lang.String> getNewClassPath()
      • setNewClassPath

        public void setNewClassPath​(Optional<java.lang.String> newClassPath)
      • isNoAnnotations

        public boolean isNoAnnotations()
      • setNoAnnotations

        public void setNoAnnotations​(boolean noAnnotations)
      • addIgnoreMissingClassRegularExpression

        public void addIgnoreMissingClassRegularExpression​(java.lang.String missingClassRegEx)
      • setReportOnlyFilename

        public void setReportOnlyFilename​(boolean reportOnlyFilename)
      • getDifferenceDescription

        public java.lang.String getDifferenceDescription()
      • toPathList

        private java.util.List<java.lang.String> toPathList​(java.util.List<JApiCmpArchive> archives)
      • toVersionList

        private java.util.List<java.lang.String> toVersionList​(java.util.List<JApiCmpArchive> archives)
      • joinOldArchives

        public java.lang.String joinOldArchives()
      • joinNewArchives

        public java.lang.String joinNewArchives()
      • joinOldVersions

        public java.lang.String joinOldVersions()
      • joinNewVersions

        public java.lang.String joinNewVersions()
      • setSemanticVersioning

        public void setSemanticVersioning​(boolean semanticVersioning)
      • isSemanticVersioning

        public boolean isSemanticVersioning()
      • isErrorOnBinaryIncompatibility

        public boolean isErrorOnBinaryIncompatibility()
      • setErrorOnBinaryIncompatibility

        public void setErrorOnBinaryIncompatibility​(boolean errorOnBinaryIncompatibility)
      • isErrorOnSourceIncompatibility

        public boolean isErrorOnSourceIncompatibility()
      • setErrorOnSourceIncompatibility

        public void setErrorOnSourceIncompatibility​(boolean errorOnSourceIncompatibility)
      • isErrorOnExclusionIncompatibility

        public boolean isErrorOnExclusionIncompatibility()
      • setErrorOnExclusionIncompatibility

        public void setErrorOnExclusionIncompatibility​(boolean errorOnExclusionIncompatibility)
      • isErrorOnModifications

        public boolean isErrorOnModifications()
      • setErrorOnModifications

        public void setErrorOnModifications​(boolean errorOnModifications)
      • isErrorOnSemanticIncompatibility

        public boolean isErrorOnSemanticIncompatibility()
      • setErrorOnSemanticIncompatibility

        public void setErrorOnSemanticIncompatibility​(boolean errorOnSemanticIncompatibility)
      • isIgnoreMissingOldVersion

        public boolean isIgnoreMissingOldVersion()
      • setIgnoreMissingOldVersion

        public void setIgnoreMissingOldVersion​(boolean ignoreMissingOldVersion)
      • isIgnoreMissingNewVersion

        public boolean isIgnoreMissingNewVersion()
      • setIgnoreMissingNewVersion

        public void setIgnoreMissingNewVersion​(boolean ignoreMissingNewVersion)
      • isHelpRequested

        public boolean isHelpRequested()
      • setHelpRequested

        public void setHelpRequested​(boolean helpRequested)
      • isErrorOnSemanticIncompatibilityForMajorVersionZero

        public boolean isErrorOnSemanticIncompatibilityForMajorVersionZero()
      • setErrorOnSemanticIncompatibilityForMajorVersionZero

        public void setErrorOnSemanticIncompatibilityForMajorVersionZero​(boolean errorOnSemanticIncompatibilityForMajorVersionZero)