uk.co.strangeskies.utility

Class Isomorphism.Mapping

java.lang.Object

uk.co.strangeskies.utility.Isomorphism.Mapping

Enclosing class:

Isomorphism

public class Isomorphism.Mapping
extends java.lang.Object

The main API surface for interacting with the Isomorphism, represents a mapping according to a given key equality.

Method Summary

Modifier and Type	Method and Description
<S> S	getCopy(Copyable<? extends S> node) Make a shallow copy of the given Copyable, or fetch an existing mapping if one has been made via this Isomorphism.
<S> S	getDeepCopy(Copyable<? extends S> node) Make a deep copy of the given Copyable, or fetch an existing mapping if one has been made via this Isomorphism.
java.util.Set<?>	getMappedNodes()
<S,C> S	getMapping(C node, java.util.function.Function<C,S> mapping) Make a mapping of the given node, or fetch an existing mapping if one has been made via this Isomorphism.
java.lang.Object	getMapping(java.lang.Object node) Fetch an existing mapping if one has been made via this Isomorphism.
<S,C> S	getPartialMapping(C node, java.util.function.BiFunction<C,java.util.function.Consumer<java.util.function.Supplier<S>>,S> mapping) Make a mapping of the given node, or fetch an existing mapping if one has been made via this Isomorphism.
<S,C> S	getPartialMapping(C node, java.util.function.Supplier<S> partial, java.util.function.Function<C,S> mapping) Make a mapping of the given node, or fetch an existing mapping if one has been made via this Isomorphism.
<S,C> S	getProxiedMapping(C node, java.lang.Class<? extends S> proxyClass, java.util.function.Function<C,S> mapping) Make a mapping of the given node, or fetch an existing mapping if one has been made via this Isomorphism.
<S,C> S	getProxiedMapping(C node, java.lang.ClassLoader classLoader, java.lang.Class<? extends S> proxyClass, java.util.function.Function<C,S> mapping) Make a mapping of the given node, or fetch an existing mapping if one has been made via this Isomorphism.
boolean	isEmpty()
<S,C> void	putMapping(C node, S mapping) Make a mapping of the given node, or fetch an existing mapping if one has been made via this Isomorphism.

Methods inherited from class java.lang.Object

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

Method Detail

getCopy

public <S> S getCopy(Copyable<? extends S> node)

Make a shallow copy of the given Copyable, or fetch an existing mapping if one has been made via this Isomorphism.

Type Parameters:

S - the type of the result

Parameters:

node - the graph node to copy

Returns:

a copy of the given node

getDeepCopy

public <S> S getDeepCopy(Copyable<? extends S> node)

Make a deep copy of the given Copyable, or fetch an existing mapping if one has been made via this Isomorphism.

Type Parameters:

S - the type of the result

Parameters:

node - the graph node to copy

Returns:

a copy of the given node

putMapping

public <S,C> void putMapping(C node,
                             S mapping)

Make a mapping of the given node, or fetch an existing mapping if one has been made via this Isomorphism.

Type Parameters:

S - the type of the node

C - the type of the result

Parameters:

node - the graph node to map

mapping - the mapping to provide

isEmpty

public boolean isEmpty()

Returns:

true if no node mappings exist yet in the isomorphism, false otherwise

getMappedNodes

public java.util.Set<?> getMappedNodes()

Returns:

all the nodes which currently have mappings in the isomorphism

getMapping

public java.lang.Object getMapping(java.lang.Object node)

Fetch an existing mapping if one has been made via this Isomorphism.

Parameters:

node - the graph node to map

Returns:

a mapping of the given node, or null if none exists

getMapping

public <S,C> S getMapping(C node,
                          java.util.function.Function<C,S> mapping)

Make a mapping of the given node, or fetch an existing mapping if one has been made via this Isomorphism.

Type Parameters:

S - the type of the node

C - the type of the result

Parameters:

node - the graph node to map

mapping - the mapping function to apply

Returns:

a mapping of the given node

getPartialMapping

public <S,C> S getPartialMapping(C node,
                                 java.util.function.BiFunction<C,java.util.function.Consumer<java.util.function.Supplier<S>>,S> mapping)

Make a mapping of the given node, or fetch an existing mapping if one has been made via this Isomorphism.

In the case of recursive graph structures we sometimes may need access to a partially constructed mapping, as we may revisit a node during the construction of its own mapping.

Once the mapping is calculated, the partial result will be removed from the isomorphism, and future attempts to map the node will return the complete result, though often the two references will be identity equal.

Type Parameters:

S - the type of the node

C - the type of the result

Parameters:

node - the graph node to map

mapping - the mapping function to apply, also accepting a consumer which can be called back with a partial result

Returns:

a mapping of the given node

getPartialMapping

public <S,C> S getPartialMapping(C node,
                                 java.util.function.Supplier<S> partial,
                                 java.util.function.Function<C,S> mapping)

Make a mapping of the given node, or fetch an existing mapping if one has been made via this Isomorphism.

In the case of recursive graph structures we sometimes may need access to a partially constructed mapping, as we may revisit a node during the construction of its own mapping.

Once the mapping is calculated, the partial result will be removed from the isomorphism, and future attempts to map the node will return the complete result, though often the two references will be identity equal.

Type Parameters:

S - the type of the node

C - the type of the result

Parameters:

node - the graph node to map

partial - a partial mapping to use until the proper mapping is computed

mapping - the mapping function to apply, also accepting a consumer which can be called back with a partial result

Returns:

a mapping of the given node

getProxiedMapping

public <S,C> S getProxiedMapping(C node,
                                 java.lang.Class<? extends S> proxyClass,
                                 java.util.function.Function<C,S> mapping)

Make a mapping of the given node, or fetch an existing mapping if one has been made via this Isomorphism.

In the case of recursive graph structures we sometimes may need access to a proxied mapping, as we may revisit a node during the construction of its own mapping.

Once the mapping is calculated, the proxied result will be removed from the isomorphism, and future attempts to map the node will return the complete result.

Type Parameters:

S - the type of the node

C - the type of the result

Parameters:

node - the graph node to map

proxyClass - the class of the result to proxy

mapping - the mapping function to apply

Returns:

a mapping of the given node

getProxiedMapping

public <S,C> S getProxiedMapping(C node,
                                 java.lang.ClassLoader classLoader,
                                 java.lang.Class<? extends S> proxyClass,
                                 java.util.function.Function<C,S> mapping)

Make a mapping of the given node, or fetch an existing mapping if one has been made via this Isomorphism.

In the case of recursive graph structures we sometimes may need access to a proxied mapping, as we may revisit a node during the construction of its own mapping.

Once the mapping is calculated, the proxied result will be removed from the isomorphism, and future attempts to map the node will return the complete result.

Type Parameters:

S - the type of the node

C - the type of the result

Parameters:

node - the graph node to map

classLoader - the class loader to use for the proxy

proxyClass - the class of the result to proxy

mapping - the mapping function to apply

Returns:

a mapping of the given node