org.mutabilitydetector.config

Class JdkConfiguration

java.lang.Object

org.mutabilitydetector.ConfigurationBuilder

org.mutabilitydetector.config.JdkConfiguration

public class JdkConfiguration
extends ConfigurationBuilder

Non-exhaustive list of immutable classes from the standard JDK.

See Also:

String, Boolean, Byte, Character, Short, Integer, Long, Float, Double, BigDecimal, BigInteger, Class, Duration, Instant, LocalDate, LocalDateTime, LocalTime, MonthDay, OffsetDateTime, OffsetTime, Period, Year, YearMonth, ZoneOffset, ZonedDateTime, DateTimeFormatter

Constructor Summary

Constructors

Constructor and Description
JdkConfiguration()

Method Summary

Modifier and Type	Method and Description
void	configure() Subclasses should override this method to configure analysis.

Methods inherited from class org.mutabilitydetector.ConfigurationBuilder

build, getCopyMethodsAllowed, getCurrentlyHardcodedResults, hardcodeAsDefinitelyImmutable, hardcodeAsDefinitelyImmutable, hardcodeAsImmutableContainerType, hardcodeAsImmutableContainerType, hardcodeResult, hardcodeResults, hardcodeResults, hardcodeValidCopyMethod, hardcodeValidCopyMethod, merge, mergeHardcodedResultsFrom, mergeImmutableContainerTypesFrom, mergeValidCopyMethodsFrom, setClassloadingPolicy, setExceptionPolicy, setHowToUseHardcodedResults, useAdvancedReassignedFieldAlgorithm

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JdkConfiguration

public JdkConfiguration()

Method Detail

configure

public void configure()

Description copied from class: ConfigurationBuilder

Subclasses should override this method to configure analysis.

It is recommended that any custom Configuration's merge with the Configurations.OUT_OF_THE_BOX_CONFIGURATION in order to remain consistent with MutabilityAssert, and the command line settings. For example:

 
 MutabilityAsserter myAsserter = MutabilityAsserter.configured(new ConfigurationBuilder() {
   @Override public void configure() {
     mergeHardcodedResultsFrom(ConfigurationBuilder.OUT_OF_THE_BOX_CONFIGURATION);
   }
 });
 
 

Similarly for DefaultCachingAnalysisSession.createWithCurrentClassPath(Configuration)

The available configuration methods are listed below.

Specified by:

configure in class ConfigurationBuilder

See Also:

ConfigurationBuilder.hardcodeResult(AnalysisResult), ConfigurationBuilder.hardcodeResults(AnalysisResult...), ConfigurationBuilder.hardcodeResults(Iterable), ConfigurationBuilder.hardcodeAsDefinitelyImmutable(Class), ConfigurationBuilder.hardcodeAsDefinitelyImmutable(String), ConfigurationBuilder.setHowToUseHardcodedResults(HardcodedResultsUsage), ConfigurationBuilder.mergeHardcodedResultsFrom(Configuration), #setExceptionPolicy(ExceptionPolicy), Configurations.OUT_OF_THE_BOX_CONFIGURATION