14 Commits

Author SHA1 Message Date
28e51d89dc feat: support for multiple independent named contexts
Some checks failed
Release / release (push) Failing after 42s
Signed-off-by: Leo Galambos <lg@hq.egothor.org>
2025-07-08 21:08:31 +02:00
33e20b7120 fix new tag naming 2025-07-06 21:00:33 +02:00
1e8fdb52dd chore: fetch-depth 0 - all history for changelog
All checks were successful
Release / release (push) Successful in 55s
2025-07-06 15:17:28 +02:00
3d2cf37a17 chore: print debug msg
All checks were successful
Release / release (push) Successful in 55s
2025-07-06 15:06:41 +02:00
e2d08d7b70 chore: print body in workflow log
All checks were successful
Release / release (push) Successful in 55s
2025-07-06 15:01:41 +02:00
e8e6a24065 chore: release naming with defaults
All checks were successful
Release / release (push) Successful in 54s
2025-07-06 14:43:42 +02:00
ad8c2a6752 chore: release naming with defaults
Some checks failed
Release / release (push) Failing after 1m14s
2025-07-06 14:37:08 +02:00
c2c1e26a7c chore: release naming with defaults 2025-07-06 14:36:06 +02:00
5d8e533eff chore: simplify release naming in Gitea UI
All checks were successful
Release / release (push) Successful in 53s
2025-07-06 14:06:37 +02:00
432b705327 docs: guide in package javadoc; fix &lt;
All checks were successful
Release / release (push) Successful in 1m24s
Signed-off-by: Leo Galambos <lg@hq.egothor.org>
2025-07-06 13:46:03 +02:00
4968cc516d fix: changelog without escape-on; javadoc was not published 2025-07-06 13:22:56 +02:00
02cd2acd6e chore: release tags with release@ prefix
All checks were successful
Release / release (push) Successful in 4m34s
2025-07-06 12:58:51 +02:00
90d4e063af gradle deps fixed
All checks were successful
Release / release (push) Successful in 52s
2025-07-05 23:18:12 +02:00
288fbfe0cc fix build without giteaToken defined
All checks were successful
Release / release (push) Successful in 3m42s
2025-07-05 23:06:07 +02:00
11 changed files with 564 additions and 162 deletions

View File

@@ -6,12 +6,6 @@
<attribute name="gradle_used_by_scope" value="main,test"/> <attribute name="gradle_used_by_scope" value="main,test"/>
</attributes> </attributes>
</classpathentry> </classpathentry>
<classpathentry kind="src" output="bin/main" path="src/main/resources">
<attributes>
<attribute name="gradle_scope" value="main"/>
<attribute name="gradle_used_by_scope" value="main,test"/>
</attributes>
</classpathentry>
<classpathentry kind="src" output="bin/test" path="src/test/java"> <classpathentry kind="src" output="bin/test" path="src/test/java">
<attributes> <attributes>
<attribute name="gradle_scope" value="test"/> <attribute name="gradle_scope" value="test"/>
@@ -19,13 +13,6 @@
<attribute name="test" value="true"/> <attribute name="test" value="true"/>
</attributes> </attributes>
</classpathentry> </classpathentry>
<classpathentry kind="src" output="bin/test" path="src/test/resources">
<attributes>
<attribute name="gradle_scope" value="test"/>
<attribute name="gradle_used_by_scope" value="test"/>
<attribute name="test" value="true"/>
</attributes>
</classpathentry>
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-21/"/> <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-21/"/>
<classpathentry kind="con" path="org.eclipse.buildship.core.gradleclasspathcontainer"/> <classpathentry kind="con" path="org.eclipse.buildship.core.gradleclasspathcontainer"/>
<classpathentry kind="output" path="bin/default"/> <classpathentry kind="output" path="bin/default"/>

View File

@@ -3,7 +3,7 @@ name: Release
on: on:
push: push:
tags: tags:
- 'conflux@*' - 'release@*'
jobs: jobs:
release: release:
@@ -12,6 +12,8 @@ jobs:
steps: steps:
- name: Checkout code - name: Checkout code
uses: actions/checkout@v4 uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Java 21 - name: Set up Java 21
uses: actions/setup-java@v3 uses: actions/setup-java@v3
@@ -38,9 +40,50 @@ jobs:
name: conflux name: conflux
path: build/libs/*.jar path: build/libs/*.jar
- name: Generate release notes
id: notes
run: |
current_tag="${{ github.ref_name }}"
# strip the prefix for sorting, keep prefix for matching
prefix="release@"
# get all matching tags, strip prefix, sort them
all_versions=$(git tag --list "${prefix}*" | sed "s/^${prefix}//" | sort -V)
# find previous version
previous_tag=""
for v in $all_versions; do
if [[ "$prefix$v" == "$current_tag" ]]; then
break
fi
previous_tag="$prefix$v"
done
if [[ -z "$previous_tag" ]]; then
range=""
else
range="$previous_tag..$current_tag"
fi
echo "Comparing range: $range"
body="## What's New"
for category in "feat: Features" "fix: Bug Fixes" "docs: Documentation" "chore: Chores"; do
prefix="${category%%:*}"
title="${category##*: }"
entries=$(git log $range --pretty=format:"- %s" --grep="^$prefix" --no-merges)
# echo -e "Found:\n\n$entries\n\n"
if [[ -n "$entries" ]]; then
body="$body\n\n### $title\n$entries"
fi
done
echo -e "$body" > /tmp/release_notes.md
- name: Create Gitea Release - name: Create Gitea Release
uses: softprops/action-gh-release@v2 uses: softprops/action-gh-release@v2
with: with:
files: build/libs/*.jar files: build/libs/*.jar
tag_name: ${{ github.ref_name }} body_path: /tmp/release_notes.md
name: Release ${{ github.ref_name }}

View File

@@ -59,7 +59,7 @@ jobs:
;; ;;
esac esac
next="$major.$minor.$patch" next="$major.$minor.$patch"
new_tag="conflux@$next" new_tag="release@$next"
git tag -s $new_tag -m "Release $new_tag" git tag -s $new_tag -m "Release $new_tag"
git push origin $new_tag git push origin $new_tag
echo "Tagged $new_tag" echo "Tagged $new_tag"

View File

@@ -6,7 +6,7 @@ plugins {
} }
group 'org.egothor' group 'org.egothor'
version gitVersion(prefix:'conflux@') version gitVersion(prefix:'release@')
repositories { repositories {
// Use Maven Central for resolving dependencies. // Use Maven Central for resolving dependencies.
@@ -25,6 +25,9 @@ java {
toolchain { toolchain {
languageVersion = JavaLanguageVersion.of(21) languageVersion = JavaLanguageVersion.of(21)
} }
withJavadocJar()
withSourcesJar()
} }
javadoc { javadoc {
@@ -36,7 +39,12 @@ tasks.named('test') {
useJUnitPlatform() useJUnitPlatform()
} }
publishing { tasks.withType(Javadoc).configureEach {
options.bottom = "Copyright &copy; 2025 Egothor"
}
if (project.hasProperty('giteaToken') && project.giteaToken) {
publishing {
publications { publications {
mavenJava(MavenPublication) { mavenJava(MavenPublication) {
from components.java from components.java
@@ -57,6 +65,9 @@ publishing {
} }
} }
} }
}
} else {
println "No giteaToken defined - skipping publishing configuration"
} }
gradle.taskGraph.whenReady { taskGraph -> gradle.taskGraph.whenReady { taskGraph ->

View File

@@ -1,12 +1,7 @@
# This file was generated by the Gradle 'init' task.
# https://docs.gradle.org/current/userguide/platforms.html#sub::toml-dependencies-format # https://docs.gradle.org/current/userguide/platforms.html#sub::toml-dependencies-format
[versions] [versions]
commons-math3 = "3.6.1"
guava = "33.1.0-jre"
junit-jupiter = "5.10.2" junit-jupiter = "5.10.2"
[libraries] [libraries]
commons-math3 = { module = "org.apache.commons:commons-math3", version.ref = "commons-math3" }
guava = { module = "com.google.guava:guava", version.ref = "guava" }
junit-jupiter = { module = "org.junit.jupiter:junit-jupiter", version.ref = "junit-jupiter" } junit-jupiter = { module = "org.junit.jupiter:junit-jupiter", version.ref = "junit-jupiter" }

View File

@@ -34,169 +34,133 @@
*/ */
package conflux; package conflux;
import java.lang.ref.WeakReference;
import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Objects; import java.util.Set;
import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CopyOnWriteArrayList;
/** /**
* A globally accessible, type-safe context for sharing data between independent * A central context manager for storing and retrieving key-value pairs in a
* parts of an application. Supports listeners that are notified whenever a * thread-safe, type-safe manner.
* registered key's value changes.
* *
* This implementation guarantees: * This enum serves as both:
* <ul> * <ul>
* <li>Strongly typed keys using {@link Key}</li> * <li>A singleton context via {@code Ctx.INSTANCE} for global/shared usage</li>
* <li>One consistent type per key name</li> * <li>A factory and registry for multiple named independent contexts</li>
* <li>Support for weak-referenced listeners to avoid memory leaks</li>
* <li>Thread-safe operations</li>
* </ul> * </ul>
* *
* Usage: * Each context provides listener support for reactive value changes.
* *
* <pre> * @see Key
* Key<Integer> COUNT = Key.of("count", Integer.class); * @see Listener
* Ctx.INSTANCE.put(COUNT, 42);
* int v = Ctx.INSTANCE.get(COUNT);
* </pre>
* *
* @author Leo Galambos * @author Leo Galambos
*/ */
public enum Ctx { public enum Ctx implements CtxInterface {
/** /**
* Singleton instance of the context. * The singleton instance representing the default/global context.
*/ */
INSTANCE; INSTANCE;
private final Map<Key<?>, Object> values = new ConcurrentHashMap<>(); /**
private final Map<String, Class<?>> keyTypes = new ConcurrentHashMap<>(); * A registry of named contexts, allowing for multiple isolated logical
private final Map<Key<?>, List<WeakReference<Listener<?>>>> listeners = new ConcurrentHashMap<>(); * contexts.
*/
private final Map<String, CtxInterface> contexts = new ConcurrentHashMap<>();
/**
* The default context instance used by this enum singleton. All interface
* method calls delegate to this context.
*/
private final CtxInterface defaultCtx = new CtxInstance();
/** /**
* Stores or updates the value for a given key. If the key is used for the first * Returns a named context. If the context does not exist, it is lazily created.
* time, its type is recorded. If the key has been used before with a different
* type, an exception will be thrown.
* *
* After setting the value, any registered listeners for that key will be * This method allows isolation between different logical scopes (e.g.,
* notified (if the value was modified). * sessions, users).
* *
* @param key the key * @param name the name of the context
* @param value the value to store * @return the associated context instance
* @param <T> the type of the value
* @throws IllegalStateException if the key is reused with a different type
*/ */
public CtxInterface getContext(String name) {
return contexts.computeIfAbsent(name, k -> new CtxInstance());
}
/**
* Returns the set of names for all currently registered contexts.
*
* @return an immutable set of context names
*/
public Set<String> contextNames() {
return Set.copyOf(contexts.keySet());
}
/**
* {@inheritDoc}
*
* Delegates to the default context instance.
*/
@Override
public <T> void put(Key<T> key, T value) { public <T> void put(Key<T> key, T value) {
keyTypes.compute(key.name(), (k, existingType) -> { defaultCtx.put(key, value);
if (existingType == null) {
return key.type();
} else {
if (!existingType.equals(key.type())) {
throw new IllegalStateException(
"Key '" + key.name() + "' already associated with type " + existingType.getName());
}
return existingType;
}
});
@SuppressWarnings("unchecked")
T previous = (T) values.put(key, value);
if (Objects.deepEquals(value, previous)) {
// no change
return;
}
// notify listeners
var list = listeners.get(key);
if (list != null) {
for (var ref : list) {
var listener = ref.get();
if (listener != null) {
@SuppressWarnings("unchecked")
Listener<T> typedListener = (Listener<T>) listener;
typedListener.valueChanged(value);
}
}
// clean up dead weak references
list.removeIf(ref -> ref.get() == null);
}
} }
/** /**
* Retrieves the value for the given key, or {@code null} if not set. * {@inheritDoc}
* *
* @param key the key * Delegates to the default context instance.
* @param <T> the type
* @return the stored value or null
*/ */
@SuppressWarnings("unchecked") @Override
public <T> T get(Key<T> key) { public <T> T get(Key<T> key) {
return (T) values.get(key); return defaultCtx.get(key);
} }
/** /**
* Checks if a value exists for the given key. * {@inheritDoc}
* *
* @param key the key * Delegates to the default context instance.
* @return true if a value is present
*/ */
@Override
public boolean contains(Key<?> key) { public boolean contains(Key<?> key) {
return values.containsKey(key); return defaultCtx.contains(key);
} }
/** /**
* Removes the value and any listeners for the given key. * {@inheritDoc}
* *
* @param key the key * Delegates to the default context instance.
* @return the removed value, or null if absent
*/ */
@Override
public Object remove(Key<?> key) { public Object remove(Key<?> key) {
keyTypes.remove(key.name()); return defaultCtx.remove(key);
var removed = values.remove(key);
listeners.remove(key);
return removed;
} }
/** /**
* Clears all keys and listeners from the context. * {@inheritDoc}
*
* Delegates to the default context instance.
*/ */
@Override
public void clear() { public void clear() {
values.clear(); defaultCtx.clear();
keyTypes.clear();
listeners.clear();
} }
/** /**
* Registers a listener to be notified whenever the value for the key changes. * {@inheritDoc}
* The listener is weakly referenced to avoid preventing its garbage collection.
* *
* @param key the key * Delegates to the default context instance.
* @param listener the listener
* @param <T> the type
*/ */
@Override
public <T> void addListener(Key<T> key, Listener<T> listener) { public <T> void addListener(Key<T> key, Listener<T> listener) {
listeners.computeIfAbsent(key, k -> new CopyOnWriteArrayList<>()).add(new WeakReference<>(listener)); defaultCtx.addListener(key, listener);
} }
/** /**
* Unregisters a previously registered listener for the key. * {@inheritDoc}
* *
* @param key the key * Delegates to the default context instance.
* @param listener the listener to remove
* @param <T> the type
*/ */
@Override
public <T> void removeListener(Key<T> key, Listener<T> listener) { public <T> void removeListener(Key<T> key, Listener<T> listener) {
var list = listeners.get(key); defaultCtx.removeListener(key, listener);
if (list != null) {
list.removeIf(ref -> {
var l = ref.get();
return l == null || l.equals(listener);
});
if (list.isEmpty()) {
listeners.remove(key);
}
}
} }
} }

View File

@@ -0,0 +1,197 @@
/**
* Copyright (C) 2025, Leo Galambos
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. All advertising materials mentioning features or use of this software must
* display the following acknowledgement:
* This product includes software developed by the Egothor project.
*
* 4. Neither the name of the copyright holder nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package conflux;
import java.lang.ref.WeakReference;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CopyOnWriteArrayList;
/**
* A globally accessible, type-safe context for sharing data between independent
* parts of an application. Supports listeners that are notified whenever a
* registered key's value changes.
*
* This implementation guarantees:
* <ul>
* <li>Strongly typed keys using {@link Key}</li>
* <li>One consistent type per key name</li>
* <li>Support for weak-referenced listeners to avoid memory leaks</li>
* <li>Thread-safe operations</li>
* </ul>
*
* @author Leo Galambos
*/
public final class CtxInstance implements CtxInterface {
private final Map<Key<?>, Object> values = new ConcurrentHashMap<>();
private final Map<String, Class<?>> keyTypes = new ConcurrentHashMap<>();
private final Map<Key<?>, List<WeakReference<Listener<?>>>> listeners = new ConcurrentHashMap<>();
/**
* Stores or updates the value for a given key. If the key is used for the first
* time, its type is recorded. If the key has been used before with a different
* type, an exception will be thrown.
*
* After setting the value, any registered listeners for that key will be
* notified (if the value was modified).
*
* @param key the key
* @param value the value to store
* @param <T> the type of the value
* @throws IllegalStateException if the key is reused with a different type
*/
@Override
public <T> void put(Key<T> key, T value) {
keyTypes.compute(key.name(), (k, existingType) -> {
if (existingType == null) {
return key.type();
} else {
if (!existingType.equals(key.type())) {
throw new IllegalStateException(
"Key '" + key.name() + "' already associated with type " + existingType.getName());
}
return existingType;
}
});
@SuppressWarnings("unchecked")
T previous = (T) values.put(key, value);
if (Objects.deepEquals(value, previous)) {
// no change
return;
}
// notify listeners
var list = listeners.get(key);
if (list != null) {
for (var ref : list) {
var listener = ref.get();
if (listener != null) {
@SuppressWarnings("unchecked")
Listener<T> typedListener = (Listener<T>) listener;
typedListener.valueChanged(value);
}
}
// clean up dead weak references
list.removeIf(ref -> ref.get() == null);
}
}
/**
* Retrieves the value for the given key, or {@code null} if not set.
*
* @param key the key
* @param <T> the type
* @return the stored value or null
*/
@Override
@SuppressWarnings("unchecked")
public <T> T get(Key<T> key) {
return (T) values.get(key);
}
/**
* Checks if a value exists for the given key.
*
* @param key the key
* @return true if a value is present
*/
@Override
public boolean contains(Key<?> key) {
return values.containsKey(key);
}
/**
* Removes the value and any listeners for the given key.
*
* @param key the key
* @return the removed value, or null if absent
*/
@Override
public Object remove(Key<?> key) {
keyTypes.remove(key.name());
var removed = values.remove(key);
listeners.remove(key);
return removed;
}
/**
* Clears all keys and listeners from the context.
*/
@Override
public void clear() {
values.clear();
keyTypes.clear();
listeners.clear();
}
/**
* Registers a listener to be notified whenever the value for the key changes.
* The listener is weakly referenced to avoid preventing its garbage collection.
*
* @param key the key
* @param listener the listener
* @param <T> the type
*/
@Override
public <T> void addListener(Key<T> key, Listener<T> listener) {
listeners.computeIfAbsent(key, k -> new CopyOnWriteArrayList<>()).add(new WeakReference<>(listener));
}
/**
* Unregisters a previously registered listener for the key.
*
* @param key the key
* @param listener the listener to remove
* @param <T> the type
*/
@Override
public <T> void removeListener(Key<T> key, Listener<T> listener) {
var list = listeners.get(key);
if (list != null) {
list.removeIf(ref -> {
var l = ref.get();
return l == null || l.equals(listener);
});
if (list.isEmpty()) {
listeners.remove(key);
}
}
}
}

View File

@@ -0,0 +1,121 @@
/**
* Copyright (C) 2025, Leo Galambos
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. All advertising materials mentioning features or use of this software must
* display the following acknowledgement:
* This product includes software developed by the Egothor project.
*
* 4. Neither the name of the copyright holder nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package conflux;
/**
* A type-safe, thread-safe context interface for storing and retrieving
* key-value pairs.
*
* Implementations of this interface support:
* <ul>
* <li>Recording type-safe associations between keys and values</li>
* <li>Automatic listener notification when a value changes</li>
* <li>Context isolation (e.g., per name or use case)</li>
* </ul>
*
* This interface is sealed to only permit known, safe implementations.
*
* @see Key
* @see Listener
*
* @author Leo Galambos
*/
public sealed interface CtxInterface permits Ctx, CtxInstance {
/**
* Stores or updates the value for a given key. If the key is used for the first
* time, its type is recorded. If the key has been used before with a different
* type, an exception will be thrown.
*
* After setting the value, any registered listeners for that key will be
* notified (if the value was modified).
*
* @param key the key
* @param value the value to store
* @param <T> the type of the value
* @throws IllegalStateException if the key is reused with a different type
*/
<T> void put(Key<T> key, T value);
/**
* Retrieves the value for the given key, or {@code null} if not set.
*
* @param key the key
* @param <T> the type
* @return the stored value or null
*/
<T> T get(Key<T> key);
/**
* Checks if a value exists for the given key.
*
* @param key the key
* @return true if a value is present
*/
boolean contains(Key<?> key);
/**
* Removes the value and any listeners for the given key.
*
* @param key the key
* @return the removed value, or null if absent
*/
Object remove(Key<?> key);
/**
* Clears all keys and listeners from the context.
*/
void clear();
/**
* Registers a listener to be notified whenever the value for the key changes.
* The listener is weakly referenced to avoid preventing its garbage collection.
*
* @param key the key
* @param listener the listener
* @param <T> the type
*/
<T> void addListener(Key<T> key, Listener<T> listener);
/**
* Unregisters a previously registered listener for the key.
*
* @param key the key
* @param listener the listener to remove
* @param <T> the type
*/
<T> void removeListener(Key<T> key, Listener<T> listener);
}

View File

@@ -0,0 +1,37 @@
/**
* Provides a lightweight, type-safe, application-wide context mechanism for
* sharing strongly typed data among otherwise decoupled classes.
*
* The {@link conflux.Ctx} enum serves as a central, generic context storage,
* supporting key-based put/get operations. Each {@link conflux.Key} instance
* defines a unique, strongly typed entry in the context, ensuring type
* consistency and preventing misuse.
*
* The {@link conflux.Listener} interface allows clients to observe value
* changes for specific keys. Listeners are weakly referenced to prevent memory
* leaks.
*
* Typical usage:
* <ul>
* <li>Define {@link conflux.Key} instances with explicit types</li>
* <li>Store values via {@code Ctx.INSTANCE.put(key, value)}</li>
* <li>Retrieve values via {@code Ctx.INSTANCE.get(key)}</li>
* <li>Register listeners with {@code Ctx.INSTANCE.addListener()}</li>
* </ul>
*
* Values and listeners can be removed individually, or the entire context can
* be cleared.
*
* Best practices:
* <ul>
* <li>Define keys as constants to maintain consistency and avoid
* collisions</li>
* <li>Remove listeners when no longer needed</li>
* <li>Use unique key names to avoid accidental type conflicts</li>
* </ul>
*
* @see conflux.Ctx
* @see conflux.Key
* @see conflux.Listener
*/
package conflux;

View File

@@ -36,6 +36,7 @@ package conflux;
import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse; import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows; import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue; import static org.junit.jupiter.api.Assertions.assertTrue;
@@ -159,4 +160,50 @@ public class CtxTest {
assertTrue(flag[0] || !flag[0]); assertTrue(flag[0] || !flag[0]);
System.out.println("...ok"); System.out.println("...ok");
} }
@Test
void testMultipleContextsIsolation() {
System.out.println("testMultipleContextsIsolation");
var ctxA = Ctx.INSTANCE.getContext("A");
var ctxB = Ctx.INSTANCE.getContext("B");
ctxA.put(intKey, 10);
ctxB.put(intKey, 20);
assertEquals(10, ctxA.get(intKey));
assertEquals(20, ctxB.get(intKey));
assertNull(Ctx.INSTANCE.get(intKey)); // Default context is separate
ctxA.clear();
assertFalse(ctxA.contains(intKey));
assertEquals(20, ctxB.get(intKey));
System.out.println("...ok");
}
@Test
void testListenerNotificationInSeparateContexts() {
System.out.println("testListenerNotificationInSeparateContexts");
var ctxA = Ctx.INSTANCE.getContext("A");
var ctxB = Ctx.INSTANCE.getContext("B");
var resultA = new StringBuilder();
var resultB = new StringBuilder();
Listener<Integer> listenerA = v -> resultA.append(v);
Listener<Integer> listenerB = v -> resultB.append(v);
ctxA.addListener(intKey, listenerA);
ctxB.addListener(intKey, listenerB);
ctxA.put(intKey, 1);
ctxB.put(intKey, 2);
ctxA.put(intKey, 3);
ctxB.put(intKey, 4);
assertEquals("13", resultA.toString());
assertEquals("24", resultB.toString());
System.out.println("...ok");
}
} }