Package org.neo4j.gds.core

Class CypherMapWrapper

java.lang.Object

org.neo4j.gds.core.CypherMapWrapper

All Implemented Interfaces:

CypherMapAccess

public final class CypherMapWrapper
extends java.lang.Object
implements CypherMapAccess

Wrapper around configuration options map

Nested Class Summary

Nested classes/interfaces inherited from interface org.neo4j.gds.core.CypherMapAccess

CypherMapAccess.PairResult

Method Summary

Modifier and Type	Method	Description
boolean	containsKey(java.lang.String key)	Checks if the given key exists in the configuration.
static CypherMapWrapper	create(@Nullable java.util.Map<java.lang.String,java.lang.Object> config)
static CypherMapWrapper	empty()
int	getLongAsInt(java.lang.String key)
java.util.Collection<java.lang.String>	keySet()
java.util.Map<java.lang.String,java.lang.Object>	toMap()	Returns a copy of the internal Map.
<V> V	typedValue(java.lang.String key, java.lang.Class<V> expectedType)
CypherMapWrapper	withBoolean(java.lang.String key, java.lang.Boolean value)
CypherMapWrapper	withEntry(java.lang.String key, java.lang.Object value)
CypherMapWrapper	withNumber(java.lang.String key, java.lang.Number value)
CypherMapWrapper	withoutAny(java.util.Collection<java.lang.String> keys)
CypherMapWrapper	withoutEntry(java.lang.String key)
CypherMapWrapper	withString(java.lang.String key, java.lang.String value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.neo4j.gds.core.CypherMapAccess

getBool, getChecked, getDouble, getInt, getLong, getNumber, getOptional, getString, getString, missingValueFor, requireBool, requireChecked, requireDouble, requireInt, requireLong, requireNumber, requireOnlyKeysFrom, requireString, verifyMutuallyExclusivePairs

Method Detail

create

public static CypherMapWrapper create(@Nullable
                                      @Nullable java.util.Map<java.lang.String,java.lang.Object> config)

empty

public static CypherMapWrapper empty()

containsKey

public boolean containsKey(java.lang.String key)

Description copied from interface: CypherMapAccess

Checks if the given key exists in the configuration.

Specified by:

containsKey in interface CypherMapAccess

Parameters:

key - key to look for

Returns:

true, iff the key exists

keySet

public java.util.Collection<java.lang.String> keySet()

Specified by:

keySet in interface CypherMapAccess

getLongAsInt

public int getLongAsInt(java.lang.String key)

Specified by:

getLongAsInt in interface CypherMapAccess

typedValue

@NotNull
public <V> V typedValue(java.lang.String key,
                        java.lang.Class<V> expectedType)

Specified by:

typedValue in interface CypherMapAccess

toMap

public java.util.Map<java.lang.String,java.lang.Object> toMap()

Description copied from interface: CypherMapAccess

Returns a copy of the internal Map.

Specified by:

toMap in interface CypherMapAccess

withString

public CypherMapWrapper withString(java.lang.String key,
                                   java.lang.String value)

withNumber

public CypherMapWrapper withNumber(java.lang.String key,
                                   java.lang.Number value)

withBoolean

public CypherMapWrapper withBoolean(java.lang.String key,
                                    java.lang.Boolean value)

withEntry

public CypherMapWrapper withEntry(java.lang.String key,
                                  java.lang.Object value)

withoutEntry

public CypherMapWrapper withoutEntry(java.lang.String key)

withoutAny

public CypherMapWrapper withoutAny(java.util.Collection<java.lang.String> keys)