## Uses of Interface
com.hazelcast.core.HazelcastInstance

- Packages that use HazelcastInstance
  Package | Description
  --- | ---
  com.hazelcast.cache | This package contains the public API extension for Hazelcast JCache, the Hazelcast implementation of the JSR-107 commonly referred to as JCache.
  com.hazelcast.client | Contains classes/interfaces related to Client
  com.hazelcast.client.console | This package contains ClientConsoleApp
  com.hazelcast.client.spi | Contains classes/interfaces related to the Hazelcast client Service Provider Interface.
  com.hazelcast.config | Provides classes for configuring HazelcastInstance.
  com.hazelcast.console | This package contains classes related to ConsoleApp
  com.hazelcast.core | Provides core API interfaces/classes.
  com.hazelcast.instance | This package contains Hazelcast Instance functionality.
  com.hazelcast.jet | Hazelcast Jet is a distributed computation engine running on top of Hazelcast IMDG technology.
  com.hazelcast.osgi | This package contains the OSGI functionality contract points for Hazelcast.
  com.hazelcast.spi | Provides interfaces/classes for the Hazelcast SPI for building distributed data structures and services.
  com.hazelcast.spring.cache | Contains Hazelcast cache classes related to Spring.
  com.hazelcast.spring.transaction | Contains Hazelcast transaction classes for Spring Transaction API.

- - ### Uses of HazelcastInstance in com.hazelcast.cache

    Methods in com.hazelcast.cache that return HazelcastInstance
    Modifier and Type | Method and Description
    --- | ---
    `HazelcastInstance` | HazelcastCacheManager.`getHazelcastInstance()` Gets the underlying `HazelcastInstance` implementation.

    Methods in com.hazelcast.cache with parameters of type HazelcastInstance
    Modifier and Type | Method and Description
    --- | ---
    `static Properties` | HazelcastCachingProvider.`propertiesByInstanceItself(HazelcastInstance instance)` Create the `Properties` with the provided instance itself.

  - ### Uses of HazelcastInstance in com.hazelcast.client

    Methods in com.hazelcast.client that return HazelcastInstance
    Modifier and Type | Method and Description
    --- | ---
    `static HazelcastInstance` | HazelcastClient.`getHazelcastClientByName(String instanceName)` Returns an existing HazelcastClient with instanceName.
    `static HazelcastInstance` | HazelcastClient.`getOrCreateHazelcastClient()` Gets or creates a new HazelcastInstance (a new client in a cluster) with the default XML configuration looked up in: System property: Hazelcast will first check if "hazelcast.client.config" system property is set to a file or a `classpath:...` path.
    `static HazelcastInstance` | HazelcastClient.`getOrCreateHazelcastClient(ClientConfig config)` Gets or creates a new HazelcastInstance (a new client in a cluster) with a certain name.
    `static HazelcastInstance` | HazelcastClient.`newHazelcastClient()` Creates a new HazelcastInstance (a new client in a cluster).
    `static HazelcastInstance` | HazelcastClient.`newHazelcastClient(ClientConfig config)` Creates a new HazelcastInstance (a new client in a cluster).
    `static HazelcastInstance` | HazelcastClient.`newHazelcastFailoverClient()` Creates a client with cluster switch capability.
    `static HazelcastInstance` | HazelcastClient.`newHazelcastFailoverClient(ClientFailoverConfig clientFailoverConfig)` Creates a client with cluster switch capability.

    Methods in com.hazelcast.client that return types with arguments of type HazelcastInstance
    Modifier and Type | Method and Description
    --- | ---
    `static Collection<HazelcastInstance>` | HazelcastClient.`getAllHazelcastClients()` Gets an immutable collection of all client HazelcastInstances created in this JVM.

    Methods in com.hazelcast.client with parameters of type HazelcastInstance
    Modifier and Type | Method and Description
    --- | ---
    `void` | ClientOutOfMemoryHandler.`onOutOfMemory(OutOfMemoryError oome, HazelcastInstance[] hazelcastInstances)`
    `static void` | HazelcastClient.`shutdown(HazelcastInstance instance)` Shutdown the provided client and remove it from the managed list

  - ### Uses of HazelcastInstance in com.hazelcast.client.console

    Methods in com.hazelcast.client.console with parameters of type HazelcastInstance
    Modifier and Type | Method and Description
    --- | ---
    `void` | ClientConsoleApp.`setHazelcast(HazelcastInstance hazelcast)`

    Constructors in com.hazelcast.client.console with parameters of type HazelcastInstance
    Constructor and Description
    `ClientConsoleApp(HazelcastInstance hazelcast)`

  - ### Uses of HazelcastInstance in com.hazelcast.client.spi

    Methods in com.hazelcast.client.spi that return HazelcastInstance
    Modifier and Type | Method and Description
    --- | ---
    `HazelcastInstance` | ProxyManager.`getHazelcastInstance()`
    `HazelcastInstance` | ClientContext.`getHazelcastInstance()`

  - ### Uses of HazelcastInstance in com.hazelcast.config

    Methods in com.hazelcast.config with parameters of type HazelcastInstance
    Modifier and Type | Method and Description
    --- | ---
    `void` | EntryListenerConfig.MapListenerToEntryListenerAdapter.`setHazelcastInstance(HazelcastInstance hazelcastInstance)`

  - ### Uses of HazelcastInstance in com.hazelcast.console

    Methods in com.hazelcast.console with parameters of type HazelcastInstance
    Modifier and Type | Method and Description
    --- | ---
    `void` | ConsoleApp.`setHazelcast(HazelcastInstance hazelcast)`
    `void` | SimulateLoadTask.`setHazelcastInstance(HazelcastInstance hazelcastInstance)`
    `void` | Echo.`setHazelcastInstance(HazelcastInstance hazelcastInstance)`

    Constructors in com.hazelcast.console with parameters of type HazelcastInstance
    Constructor and Description
    `ConsoleApp(HazelcastInstance hazelcast)`

  - ### Uses of HazelcastInstance in com.hazelcast.core

    Methods in com.hazelcast.core that return HazelcastInstance
    Modifier and Type | Method and Description
    --- | ---
    `static HazelcastInstance` | Hazelcast.`getHazelcastInstanceByName(String instanceName)` Returns an existing HazelcastInstance with instanceName.
    `static HazelcastInstance` | Hazelcast.`getOrCreateHazelcastInstance()` Gets or creates a HazelcastInstance with the default XML configuration looked up in: System property: Hazelcast will first check if "hazelcast.config" system property is set to a file or a `classpath:...` path.
    `static HazelcastInstance` | Hazelcast.`getOrCreateHazelcastInstance(Config config)` Gets or creates the HazelcastInstance with a certain name.
    `static HazelcastInstance` | Hazelcast.`newHazelcastInstance()` Creates a new HazelcastInstance (a new node in a cluster).
    `static HazelcastInstance` | Hazelcast.`newHazelcastInstance(Config config)` Creates a new HazelcastInstance (a new node in a cluster).

    Methods in com.hazelcast.core that return types with arguments of type HazelcastInstance
    Modifier and Type | Method and Description
    --- | ---
    `static Set<HazelcastInstance>` | Hazelcast.`getAllHazelcastInstances()` Returns all active/running HazelcastInstances on this JVM.

    Methods in com.hazelcast.core with parameters of type HazelcastInstance
    Modifier and Type | Method and Description
    --- | ---
    `void` | MapLoaderLifecycleSupport.`init(HazelcastInstance hazelcastInstance, Properties properties, String mapName)` Initializes this MapLoader implementation.
    `abstract void` | OutOfMemoryHandler.`onOutOfMemory(OutOfMemoryError oome, HazelcastInstance[] hazelcastInstances)` When an `OutOfMemoryError` is caught by Hazelcast threads, this method is called for ALL `HazelcastInstance`s knows by current JVM (actually ClassLoader).
    `void` | HazelcastInstanceAware.`setHazelcastInstance(HazelcastInstance hazelcastInstance)` Gets the HazelcastInstance reference when submitting a Runnable/Callable using Hazelcast ExecutorService.
    `protected void` | OutOfMemoryHandler.`tryCloseConnections(HazelcastInstance hazelcastInstance)` Tries to close the server socket and connections to other `HazelcastInstance`s.
    `protected void` | OutOfMemoryHandler.`tryShutdown(HazelcastInstance hazelcastInstance)` Tries to shutdown `HazelcastInstance` forcefully; including closing sockets and connections, stopping threads, etc.

  - ### Uses of HazelcastInstance in com.hazelcast.instance

    Classes in com.hazelcast.instance that implement HazelcastInstance
    Modifier and Type | Class and Description
    --- | ---
    `class` | `HazelcastInstanceImpl`
    `class` | `HazelcastInstanceProxy` A proxy around the actual HazelcastInstanceImpl.

    Methods in com.hazelcast.instance that return HazelcastInstance
    Modifier and Type | Method and Description
    --- | ---
    `static HazelcastInstance` | HazelcastInstanceFactory.`getHazelcastInstance(String instanceName)`
    `static HazelcastInstance` | HazelcastInstanceFactory.`getOrCreateHazelcastInstance(Config config)`
    `static HazelcastInstance` | HazelcastInstanceFactory.`newHazelcastInstance(Config config)` Creates a new Hazelcast instance.
    `static HazelcastInstance` | HazelcastInstanceFactory.`newHazelcastInstance(Config config, String instanceName, NodeContext nodeContext)` Creates a new Hazelcast instance.

    Methods in com.hazelcast.instance that return types with arguments of type HazelcastInstance
    Modifier and Type | Method and Description
    --- | ---
    `static Set<HazelcastInstance>` | HazelcastInstanceFactory.`getAllHazelcastInstances()`

    Methods in com.hazelcast.instance with parameters of type HazelcastInstance
    Modifier and Type | Method and Description
    --- | ---
    `static void` | OutOfMemoryErrorDispatcher.`deregisterClient(HazelcastInstance instance)`
    `static void` | OutOfMemoryErrorDispatcher.`deregisterServer(HazelcastInstance instance)`
    `void` | DefaultOutOfMemoryHandler.`onOutOfMemory(OutOfMemoryError oome, HazelcastInstance[] hazelcastInstances)`
    `static void` | OutOfMemoryErrorDispatcher.`registerClient(HazelcastInstance instance)`
    `static void` | OutOfMemoryErrorDispatcher.`registerServer(HazelcastInstance instance)`
    `void` | MemberImpl.`setHazelcastInstance(HazelcastInstance hazelcastInstance)`
    `static void` | OutOfMemoryHandlerHelper.`tryCloseConnections(HazelcastInstance hazelcastInstance)`
    `static void` | OutOfMemoryHandlerHelper.`tryShutdown(HazelcastInstance hazelcastInstance)`

  - ### Uses of HazelcastInstance in com.hazelcast.jet

    Methods in com.hazelcast.jet that return HazelcastInstance
    Modifier and Type | Method and Description
    --- | ---
    `HazelcastInstance` | JetInstance.`getHazelcastInstance()` Returns the underlying Hazelcast IMDG instance used by Jet.

  - ### Uses of HazelcastInstance in com.hazelcast.osgi

    Subinterfaces of HazelcastInstance in com.hazelcast.osgi
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `HazelcastOSGiInstance` Contract point for `HazelcastInstance` implementations based on OSGi service.

    Methods in com.hazelcast.osgi that return HazelcastInstance
    Modifier and Type | Method and Description
    --- | ---
    `HazelcastInstance` | HazelcastOSGiInstance.`getDelegatedInstance()` Gets the delegated (underlying) `HazelcastInstance`.

  - ### Uses of HazelcastInstance in com.hazelcast.spi

    Methods in com.hazelcast.spi that return HazelcastInstance
    Modifier and Type | Method and Description
    --- | ---
    `HazelcastInstance` | NodeEngine.`getHazelcastInstance()` Returns the HazelcastInstance that this `NodeEngine` belongs to.

  - ### Uses of HazelcastInstance in com.hazelcast.spring.cache

    Methods in com.hazelcast.spring.cache that return HazelcastInstance
    Modifier and Type | Method and Description
    --- | ---
    `HazelcastInstance` | HazelcastCacheManager.`getHazelcastInstance()`

    Methods in com.hazelcast.spring.cache with parameters of type HazelcastInstance
    Modifier and Type | Method and Description
    --- | ---
    `static javax.cache.CacheManager` | SpringHazelcastCachingProvider.`getCacheManager(HazelcastInstance instance, String uriString, Properties props)` Creates a `CacheManager` on an existing HazelcastInstance.
    `void` | HazelcastCacheManager.`setHazelcastInstance(HazelcastInstance hazelcastInstance)`

    Constructors in com.hazelcast.spring.cache with parameters of type HazelcastInstance
    Constructor and Description
    `HazelcastCacheManager(HazelcastInstance hazelcastInstance)`

  - ### Uses of HazelcastInstance in com.hazelcast.spring.transaction

    Methods in com.hazelcast.spring.transaction with parameters of type HazelcastInstance
    Modifier and Type | Method and Description
    --- | ---
    `static TransactionContext` | HazelcastTransactionManager.`getTransactionContext(HazelcastInstance hazelcastInstance)` Returns the transaction context for the given Hazelcast instance bounded to the current thread.

    Constructors in com.hazelcast.spring.transaction with parameters of type HazelcastInstance
    Constructor and Description
    `HazelcastTransactionManager(HazelcastInstance hazelcastInstance)`

Copyright © 2020. All rights reserved.