Package org.ldaptive

Interface Freezable

All Known Implementing Classes:
AbstractAuthenticationHandler, AbstractBinaryAttributeHandler, AbstractConfig, AbstractConnectionPool, AbstractConnectionStrategy, AbstractConnectionValidator, AbstractEntryHandler, AbstractFollowReferralHandler, AbstractFollowSearchReferralHandler, AbstractFreezable, AbstractMessageFunctionalEntryHandler, AbstractNamedSchemaElement, AbstractOperationConnectionValidator, AbstractOperationFactory, AbstractPassiveConnectionStrategy, AbstractPruneStrategy, AbstractResponseControl, AbstractSchemaElement, AbstractSearchEntryResolver, AbstractSearchOperationFactory, ActiveDirectoryAuthenticationResponseHandler, ActivePassiveConnectionStrategy, AgePruneStrategy, AggregateAuthenticationHandler, AggregateAuthenticationResponseHandler, AggregateDnResolver, AggregateEntryResolver, AttributeType, AuthenticationResponse, Authenticator, AuthorizationIdentityEntryResolver, AuthorizationIdentityResponseControl, BindConnectionInitializer, BindConnectionPassivator, BlockingConnectionPool, CaseChangeEntryHandler, CompareAuthenticationHandler, CompareConnectionValidator, ConnectionConfig, DefaultConnectionFactory, DefaultLdapEntryManager, DirSyncControl, DITContentRule, DITStructureRule, Dn, DnAttributeEntryHandler, DnsResolverConnectionStrategy, DnsSrvConnectionStrategy, EDirectoryAuthenticationResponseHandler, EntryChangeNotificationControl, Extensions, FollowAddReferralHandler, FollowCompareReferralHandler, FollowDeleteReferralHandler, FollowModifyDnReferralHandler, FollowModifyReferralHandler, FollowSearchReferralHandler, FollowSearchResultReferenceHandler, FormatDnResolver, FreeIPAAuthenticationResponseHandler, GenericControl, GetStatsControl, IdlePruneStrategy, KeyStoreCredentialConfig, LdapAttribute, LdapEntry, MatchingRule, MatchingRuleUse, MergeAttributeEntryHandler, MessageFunctional, MessageFunctional.BiConsumer, MessageFunctional.Consumer, MessageFunctional.Function, NameForm, ObjectClass, ObjectGuidHandler, ObjectSidHandler, PagedResultsClient, PagedResultsControl, PasswordExpiredControl, PasswordExpiringControl, PasswordPolicyControl, PooledConnectionFactory, PrimaryGroupIdHandler, RandomConnectionStrategy, RangeEntryHandler, RecursiveResultHandler, RoundRobinConnectionStrategy, SaslConfig, Schema, SchemaElementRegistry, SearchConnectionValidator, SearchDnResolver, SearchEntryResolver, SearchResponse, SearchResultReference, SearchRoleResolver, SessionTrackingControl, SimpleBindAuthenticationHandler, SingleConnectionFactory, SortResponseControl, SslConfig, SyncDoneControl, SyncStateControl, Syntax, ThreadPoolConfig, UnicodePwdAttribute, VirtualListViewClient, VirtualListViewResponseControl, WhoAmIEntryResolver, X509CredentialConfig
public interface Freezable
Interface for objects that can be made immutable after creation by invoking the freeze() method.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    assertMutable()
    Asserts that this object is in a state to permit mutations.
    void
    freeze()
    Freezes this object, making it immutable.
    boolean
    isFrozen()
    Determines whether this object is frozen, i.e. immutable.

  • Method Details

    • freeze

      void freeze()
      Freezes this object, making it immutable.

    • isFrozen

      boolean isFrozen()
      Determines whether this object is frozen, i.e. immutable.
      Returns:
      True if freeze() has been invoked, false otherwise.

    • assertMutable

      void assertMutable()
      Asserts that this object is in a state to permit mutations. Classes that implement this interface should invoke this method prior to performing any mutation of internal state as a means of implementing the "frozen" usage contract.
      Throws:
      IllegalStateException - if this object is frozen (i.e. immutable).