Skip to content

Refinements to registry tags #147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mcslee merged 1 commit into from
Oct 9, 2025
Merged

Refinements to registry tags #147

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 26 additions & 5 deletions src/main/java/heronarts/lx/LXRegistry.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@
import heronarts.lx.pattern.LXPattern;
import heronarts.lx.pattern.PatternRack;
import heronarts.lx.structure.LXFixture;
import heronarts.lx.utils.LXUtils;

/**
* Registry container for content classes used by the LX implementation
Expand Down Expand Up @@ -290,8 +291,8 @@ public LXRegistry removeListener(Listener listener) {
/**
* Globally registered tags
*/
public final Map<Class<? extends LXComponent>, List<String>> tags =
Collections.unmodifiableMap(this.mutableTags);
private final Map<Class<? extends LXComponent>, List<String>> tags =
new HashMap<>();

private final List<Class<? extends LXBlend>> mutableChannelBlends =
new ArrayList<Class<? extends LXBlend>>(DEFAULT_CHANNEL_BLENDS);
Expand Down Expand Up @@ -400,7 +401,6 @@ private JsonFixture(File file, String prefix) {
*/
public final List<LXClassLoader.Package> packages = Collections.unmodifiableList(this.mutablePackages);


private final List<Plugin> mutablePlugins = new ArrayList<Plugin>();

/**
Expand Down Expand Up @@ -556,6 +556,19 @@ public void dispose() {
public LXRegistry(LX lx) {
this.lx = lx;
this.classLoader = new LXClassLoader(lx);

for (Class<? extends LXPattern> pattern : DEFAULT_PATTERNS) {
addDefaultTags(pattern);
}
for (Class<? extends LXEffect> effect : DEFAULT_EFFECTS) {
addDefaultTags(effect);
}
for (Class<? extends LXModulator> modulator : DEFAULT_MODULATORS) {
addDefaultTags(modulator);
}
for (Class<? extends LXFixture> fixture : DEFAULT_FIXTURES) {
addDefaultTags(fixture);
}
}

public LXClassLoader getClassLoader() {
Expand Down Expand Up @@ -1186,10 +1199,17 @@ private void addDefaultTags(Class<? extends LXComponent> component) {
* @return this
*/
public LXRegistry addTag(Class<? extends LXComponent> component, String tag) {
if (tag == null) {
throw new IllegalArgumentException("Tag may not be null for class " + component.getName());
} else if (!tag.matches("^[a-zA-Z0-9/]+$")) {
throw new IllegalArgumentException("Tag '" + tag + "' for class " + component.getName() + " contains illegal characters - only alphanumerics and slashes allowed");
}
List<String> tags = this.mutableTags.get(component);
if (tags == null) {
tags = new ArrayList<String>();
List<String> unmodifiableTags = Collections.unmodifiableList(tags);
this.mutableTags.put(component, tags);
this.tags.put(component, unmodifiableTags);
}
if (tags.contains(tag)) {
LX.error("Cannot add duplicate tag \"" + tag + "\" to class " + component.getName());
Expand All @@ -1215,6 +1235,7 @@ public LXRegistry removeTag(Class<? extends LXComponent> component, String tag)
tags.remove(tag);
if (tags.isEmpty()) {
this.mutableTags.remove(component);
this.tags.remove(component);
}
return this;
}
Expand All @@ -1223,10 +1244,10 @@ public LXRegistry removeTag(Class<? extends LXComponent> component, String tag)
* Get the set of tags for a given component class
*
* @param component Component type
* @return this
* @return An unmodifiable list of tags, or null if no tags exist
*/
public List<String> getTags(Class<? extends LXComponent> component) {
return this.mutableTags.get(component);
return this.tags.get(component);
}

/**
Expand Down