Util (Hazelcast Root 5.5.2 API)

java.lang.Object

com.hazelcast.jet.Util

public final class Util extends Object

Miscellaneous utility methods useful in DAG building logic.

Since:: Jet 3.0

Method Summary

Modifier and Type

Method

Description

static <K, V> FunctionEx<EventJournalCacheEvent<K,V>,V>

cacheEventNewValue()

Returns a projection that extracts the new value from an EventJournalCacheEvent.

static <K, V> FunctionEx<EventJournalCacheEvent<K,V>,Map.Entry<K,V>>

cacheEventToEntry()

Returns a projection that converts the EventJournalCacheEvent to a Map.Entry using the event's new value as a value.

static <K, V> PredicateEx<EventJournalCacheEvent<K,V>>

cachePutEvents()

Returns a predicate for Sources.cacheJournal(java.lang.String, com.hazelcast.jet.pipeline.JournalInitialPosition, com.hazelcast.function.FunctionEx<? super com.hazelcast.cache.EventJournalCacheEvent<K, V>, ? extends T>, com.hazelcast.function.PredicateEx<? super com.hazelcast.cache.EventJournalCacheEvent<K, V>>) and Sources.remoteCacheJournal(java.lang.String, com.hazelcast.client.config.ClientConfig, com.hazelcast.jet.pipeline.JournalInitialPosition, com.hazelcast.function.FunctionEx<? super com.hazelcast.cache.EventJournalCacheEvent<K, V>, ? extends T>, com.hazelcast.function.PredicateEx<? super com.hazelcast.cache.EventJournalCacheEvent<K, V>>) that passes only CREATED and UPDATED events.

static <K, V> Map.Entry<K,V>

entry(K key, V value)

Returns a Serializable Map.Entry with nullable key and value.

static Path

getFilePathOfClasspathResource(String resourcePath)

Takes the pathname of a classpath resource and returns a Path that corresponds to it.

static long

idFromString(String str)

Parses the jobId formatted with idToString(long).

static String

idToString(long id)

Converts a long job or execution ID to a string representation.

static <K, V> FunctionEx<EventJournalMapEvent<K,V>,V>

mapEventNewValue()

Returns a projection that extracts the new value from an EventJournalMapEvent.

static <K, V> FunctionEx<EventJournalMapEvent<K,V>,Map.Entry<K,V>>

mapEventToEntry()

Returns a projection that converts the EventJournalMapEvent to a Map.Entry using the event's new value as a value.

static <K, V> PredicateEx<EventJournalMapEvent<K,V>>

mapPutEvents()

Returns a predicate for Sources.mapJournal(java.lang.String, com.hazelcast.jet.pipeline.JournalInitialPosition, com.hazelcast.function.FunctionEx<? super com.hazelcast.map.EventJournalMapEvent<K, V>, ? extends T>, com.hazelcast.function.PredicateEx<? super com.hazelcast.map.EventJournalMapEvent<K, V>>) and Sources.remoteMapJournal(java.lang.String, com.hazelcast.client.config.ClientConfig, com.hazelcast.jet.pipeline.JournalInitialPosition, com.hazelcast.function.FunctionEx<? super com.hazelcast.map.EventJournalMapEvent<K, V>, ? extends T>, com.hazelcast.function.PredicateEx<? super com.hazelcast.map.EventJournalMapEvent<K, V>>) that passes only ADDED and UPDATED events.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- entry
  
  public static <K, V> Map.Entry<K,V> entry(@Nullable K key, @Nullable V value)
  
  Returns a Serializable Map.Entry with nullable key and value. If nullability and serializability are not required, consider using Map#entry(K, V).
- mapPutEvents
  
  public static <K, V> PredicateEx<EventJournalMapEvent<K,V>> mapPutEvents()
  
  Returns a predicate for Sources.mapJournal(java.lang.String, com.hazelcast.jet.pipeline.JournalInitialPosition, com.hazelcast.function.FunctionEx<? super com.hazelcast.map.EventJournalMapEvent<K, V>, ? extends T>, com.hazelcast.function.PredicateEx<? super com.hazelcast.map.EventJournalMapEvent<K, V>>) and Sources.remoteMapJournal(java.lang.String, com.hazelcast.client.config.ClientConfig, com.hazelcast.jet.pipeline.JournalInitialPosition, com.hazelcast.function.FunctionEx<? super com.hazelcast.map.EventJournalMapEvent<K, V>, ? extends T>, com.hazelcast.function.PredicateEx<? super com.hazelcast.map.EventJournalMapEvent<K, V>>) that passes only ADDED and UPDATED events.
- cachePutEvents
  
  public static <K, V> PredicateEx<EventJournalCacheEvent<K,V>> cachePutEvents()
  
  Returns a predicate for Sources.cacheJournal(java.lang.String, com.hazelcast.jet.pipeline.JournalInitialPosition, com.hazelcast.function.FunctionEx<? super com.hazelcast.cache.EventJournalCacheEvent<K, V>, ? extends T>, com.hazelcast.function.PredicateEx<? super com.hazelcast.cache.EventJournalCacheEvent<K, V>>) and Sources.remoteCacheJournal(java.lang.String, com.hazelcast.client.config.ClientConfig, com.hazelcast.jet.pipeline.JournalInitialPosition, com.hazelcast.function.FunctionEx<? super com.hazelcast.cache.EventJournalCacheEvent<K, V>, ? extends T>, com.hazelcast.function.PredicateEx<? super com.hazelcast.cache.EventJournalCacheEvent<K, V>>) that passes only CREATED and UPDATED events.
- mapEventToEntry
  
  public static <K, V> FunctionEx<EventJournalMapEvent<K,V>,Map.Entry<K,V>> mapEventToEntry()
  
  Returns a projection that converts the EventJournalMapEvent to a Map.Entry using the event's new value as a value.
  See Also:
  
  Sources.mapJournal(java.lang.String, com.hazelcast.jet.pipeline.JournalInitialPosition, com.hazelcast.function.FunctionEx<? super com.hazelcast.map.EventJournalMapEvent<K, V>, ? extends T>, com.hazelcast.function.PredicateEx<? super com.hazelcast.map.EventJournalMapEvent<K, V>>)
  
  Sources.remoteMapJournal(java.lang.String, com.hazelcast.client.config.ClientConfig, com.hazelcast.jet.pipeline.JournalInitialPosition, com.hazelcast.function.FunctionEx<? super com.hazelcast.map.EventJournalMapEvent<K, V>, ? extends T>, com.hazelcast.function.PredicateEx<? super com.hazelcast.map.EventJournalMapEvent<K, V>>)
- mapEventNewValue
  
  public static <K, V> FunctionEx<EventJournalMapEvent<K,V>,V> mapEventNewValue()
  
  Returns a projection that extracts the new value from an EventJournalMapEvent.
  See Also:
  
  Sources.mapJournal(java.lang.String, com.hazelcast.jet.pipeline.JournalInitialPosition, com.hazelcast.function.FunctionEx<? super com.hazelcast.map.EventJournalMapEvent<K, V>, ? extends T>, com.hazelcast.function.PredicateEx<? super com.hazelcast.map.EventJournalMapEvent<K, V>>)
  
  Sources.remoteMapJournal(java.lang.String, com.hazelcast.client.config.ClientConfig, com.hazelcast.jet.pipeline.JournalInitialPosition, com.hazelcast.function.FunctionEx<? super com.hazelcast.map.EventJournalMapEvent<K, V>, ? extends T>, com.hazelcast.function.PredicateEx<? super com.hazelcast.map.EventJournalMapEvent<K, V>>)
- cacheEventToEntry
  
  public static <K, V> FunctionEx<EventJournalCacheEvent<K,V>,Map.Entry<K,V>> cacheEventToEntry()
  
  Returns a projection that converts the EventJournalCacheEvent to a Map.Entry using the event's new value as a value.
  See Also:
  
  Sources.cacheJournal(java.lang.String, com.hazelcast.jet.pipeline.JournalInitialPosition, com.hazelcast.function.FunctionEx<? super com.hazelcast.cache.EventJournalCacheEvent<K, V>, ? extends T>, com.hazelcast.function.PredicateEx<? super com.hazelcast.cache.EventJournalCacheEvent<K, V>>)
  
  Sources.remoteCacheJournal(java.lang.String, com.hazelcast.client.config.ClientConfig, com.hazelcast.jet.pipeline.JournalInitialPosition, com.hazelcast.function.FunctionEx<? super com.hazelcast.cache.EventJournalCacheEvent<K, V>, ? extends T>, com.hazelcast.function.PredicateEx<? super com.hazelcast.cache.EventJournalCacheEvent<K, V>>)
- cacheEventNewValue
  
  public static <K, V> FunctionEx<EventJournalCacheEvent<K,V>,V> cacheEventNewValue()
  
  Returns a projection that extracts the new value from an EventJournalCacheEvent.
  See Also:
  
  Sources.mapJournal(java.lang.String, com.hazelcast.jet.pipeline.JournalInitialPosition, com.hazelcast.function.FunctionEx<? super com.hazelcast.map.EventJournalMapEvent<K, V>, ? extends T>, com.hazelcast.function.PredicateEx<? super com.hazelcast.map.EventJournalMapEvent<K, V>>)
  
  Sources.remoteMapJournal(java.lang.String, com.hazelcast.client.config.ClientConfig, com.hazelcast.jet.pipeline.JournalInitialPosition, com.hazelcast.function.FunctionEx<? super com.hazelcast.map.EventJournalMapEvent<K, V>, ? extends T>, com.hazelcast.function.PredicateEx<? super com.hazelcast.map.EventJournalMapEvent<K, V>>)
- idToString
  
  @Nonnull public static String idToString(long id)
  
  Converts a long job or execution ID to a string representation. Currently it is an unsigned 16-digit hex number.
- idFromString
  
  public static long idFromString(String str)
  
  Parses the jobId formatted with idToString(long).
  The method is lenient: if the string doesn't match the structure of the ID generated by idToString or if the string is null, it will return -1.
  
  Returns:
  
  the parsed ID or -1 if parsing failed.
- getFilePathOfClasspathResource
  
  public static Path getFilePathOfClasspathResource(String resourcePath)
  
  Takes the pathname of a classpath resource and returns a Path that corresponds to it. This works only for resources that represent files or directories on the local file system (i.e., the class loader returns a file: URL).
  For example, if you have a project directory src/main/resources/python, the files in it will become classpath resources with the "python" path prefix. Calling getFilePathOfClasspathResource("python") will return the full path to the above directory in the project.
  
  Parameters:
  
  resourcePath - the pathname of the classpath resource
  
  Returns:
  
  a Path pointing to the project directory corresponding to the pathname
  
  Since:
  
  Jet 4.0