JavaDoc and use of diamond operator
Project: http://git-wip-us.apache.org/repos/asf/tomee/repo Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/7ffcb012 Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/7ffcb012 Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/7ffcb012 Branch: refs/heads/master Commit: 7ffcb01291a9cb369d1e5ddd1612bdf9f196698c Parents: 5af81aa Author: Hayri Cicek <[email protected]> Authored: Fri Dec 7 22:13:18 2018 +0100 Committer: Hayri Cicek <[email protected]> Committed: Fri Dec 7 22:13:18 2018 +0100 ---------------------------------------------------------------------- .../openejb/loader/event/ComponentAdded.java | 13 +++ .../openejb/loader/event/ComponentRemoved.java | 13 +++ .../loader/provisining/HttpResolver.java | 5 ++ .../loader/provisining/MavenResolver.java | 10 +++ .../provisining/ProvisiningResolverCreated.java | 9 ++ .../provisining/ProvisioningResolver.java | 28 +++++++ .../provisining/ProvisioningResolverAware.java | 5 ++ .../openejb/observer/ObserverManager.java | 88 +++++++++++++++----- .../openejb/observer/event/ObserverAdded.java | 8 ++ .../openejb/observer/event/ObserverFailed.java | 23 +++++ .../openejb/observer/event/ObserverRemoved.java | 8 ++ 11 files changed, 188 insertions(+), 22 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/tomee/blob/7ffcb012/container/openejb-loader/src/main/java/org/apache/openejb/loader/event/ComponentAdded.java ---------------------------------------------------------------------- diff --git a/container/openejb-loader/src/main/java/org/apache/openejb/loader/event/ComponentAdded.java b/container/openejb-loader/src/main/java/org/apache/openejb/loader/event/ComponentAdded.java index 5370107..9568d87 100644 --- a/container/openejb-loader/src/main/java/org/apache/openejb/loader/event/ComponentAdded.java +++ b/container/openejb-loader/src/main/java/org/apache/openejb/loader/event/ComponentAdded.java @@ -27,15 +27,28 @@ public class ComponentAdded<T> { private final Class<T> type; private final T component; + /** + * + * @param type + * @param component + */ public ComponentAdded(final Class<T> type, final T component) { this.type = type; this.component = component; } + /** + * + * @return + */ public Class<T> getType() { return type; } + /** + * + * @return + */ public T getComponent() { return component; } http://git-wip-us.apache.org/repos/asf/tomee/blob/7ffcb012/container/openejb-loader/src/main/java/org/apache/openejb/loader/event/ComponentRemoved.java ---------------------------------------------------------------------- diff --git a/container/openejb-loader/src/main/java/org/apache/openejb/loader/event/ComponentRemoved.java b/container/openejb-loader/src/main/java/org/apache/openejb/loader/event/ComponentRemoved.java index 095aece..aae7ba2 100644 --- a/container/openejb-loader/src/main/java/org/apache/openejb/loader/event/ComponentRemoved.java +++ b/container/openejb-loader/src/main/java/org/apache/openejb/loader/event/ComponentRemoved.java @@ -27,15 +27,28 @@ public class ComponentRemoved<T> { private final Class<T> type; private final T component; + /** + * + * @param type + * @param component + */ public ComponentRemoved(final Class<T> type, final T component) { this.type = type; this.component = component; } + /** + * + * @return + */ public Class<T> getType() { return type; } + /** + * + * @return + */ public T getComponent() { return component; } http://git-wip-us.apache.org/repos/asf/tomee/blob/7ffcb012/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/HttpResolver.java ---------------------------------------------------------------------- diff --git a/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/HttpResolver.java b/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/HttpResolver.java index db8139f..34d625f 100644 --- a/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/HttpResolver.java +++ b/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/HttpResolver.java @@ -57,6 +57,11 @@ public class HttpResolver implements ArchiveResolver { return lastPart(rawLocation.replace(':', '/')); } + /** + * + * @param location String + * @return String + */ public static String lastPart(final String location) { int idx = location.lastIndexOf('/'); if (idx <= 0) { http://git-wip-us.apache.org/repos/asf/tomee/blob/7ffcb012/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/MavenResolver.java ---------------------------------------------------------------------- diff --git a/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/MavenResolver.java b/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/MavenResolver.java index 2f8c60d..e753b4f 100644 --- a/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/MavenResolver.java +++ b/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/MavenResolver.java @@ -93,6 +93,12 @@ public class MavenResolver implements ArchiveResolver, ProvisioningResolverAware return Objects.requireNonNull(SystemInstance.get().getComponent(ProvisioningResolver.class)).resolveStream(repo1Url); } + /** + * + * @param raw String + * @return String + * @throws MalformedURLException + */ public String quickMvnUrl(final String raw) throws MalformedURLException { final String base; if (raw.contains(SNAPSHOT_SUFFIX) && raw.contains("apache")) { @@ -289,6 +295,10 @@ public class MavenResolver implements ArchiveResolver, ProvisioningResolverAware return defaultVersion; } + /** + * + * @param resolver ProvisioningResolver + */ @Override public void setResolver(final ProvisioningResolver resolver) { this.resolver = resolver; http://git-wip-us.apache.org/repos/asf/tomee/blob/7ffcb012/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/ProvisiningResolverCreated.java ---------------------------------------------------------------------- diff --git a/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/ProvisiningResolverCreated.java b/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/ProvisiningResolverCreated.java index fbdc767..421f887 100644 --- a/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/ProvisiningResolverCreated.java +++ b/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/ProvisiningResolverCreated.java @@ -22,10 +22,19 @@ import org.apache.openejb.observer.Event; public class ProvisiningResolverCreated { private final ProvisioningResolver resolver; + /** + * + * @param provisioningResolver ProvisioningResolver + */ public ProvisiningResolverCreated(final ProvisioningResolver provisioningResolver) { resolver = provisioningResolver; } + /** + * + * @param resolver ArchiveResolver + * @return ProvisiningResolverCreated + */ public ProvisiningResolverCreated register(final ArchiveResolver resolver) { this.resolver.addResolver(resolver); return this; http://git-wip-us.apache.org/repos/asf/tomee/blob/7ffcb012/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/ProvisioningResolver.java ---------------------------------------------------------------------- diff --git a/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/ProvisioningResolver.java b/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/ProvisioningResolver.java index 0d881fc..698b002 100644 --- a/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/ProvisioningResolver.java +++ b/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/ProvisioningResolver.java @@ -74,16 +74,29 @@ public class ProvisioningResolver { } } + /** + * + * @param resolver ArchiveResolver + */ public void addResolver(final ArchiveResolver resolver) { if (resolvers.put(resolver.prefix(), resolver) != null) { Logger.getLogger(ProvisioningResolver.class.getName()).warning("Overriding resolver " + resolver.prefix() + " with " + resolver); } } + /** + * + * @param resolver ArchiveResolver + */ public void removeResolver(final ArchiveResolver resolver) { resolvers.remove(resolver.prefix()); } + /** + * + * @param rawLocation String + * @return + */ public Set<String> realLocation(final String rawLocation) { // if direct file path then use it final File file = new File(rawLocation); @@ -158,6 +171,12 @@ public class ProvisioningResolver { } } + /** + * + * @param rawLocation String + * @return InputStream + * @throws MalformedURLException + */ public InputStream resolveStream(final String rawLocation) throws MalformedURLException { final File file = new File(rawLocation); if (file.exists()) { @@ -172,10 +191,19 @@ public class ProvisioningResolver { return null; } + /** + * + * @return String + */ public static String cache() { return System.getProperty(OPENEJB_DEPLOYER_CACHE_FOLDER, TEMP_DIR); } + /** + * + * @param path String + * @return File + */ public static File cacheFile(final String path) { final String cache = cache(); if (new File(cache).isAbsolute()) { http://git-wip-us.apache.org/repos/asf/tomee/blob/7ffcb012/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/ProvisioningResolverAware.java ---------------------------------------------------------------------- diff --git a/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/ProvisioningResolverAware.java b/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/ProvisioningResolverAware.java index 9b290d8..7fc4dd3 100644 --- a/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/ProvisioningResolverAware.java +++ b/container/openejb-loader/src/main/java/org/apache/openejb/loader/provisining/ProvisioningResolverAware.java @@ -21,5 +21,10 @@ package org.apache.openejb.loader.provisining; // // ex: mvn delegates to http if the archive is not found locally public interface ProvisioningResolverAware { + + /** + * + * @param resolver ProvisioningResolver + */ void setResolver(ProvisioningResolver resolver); } http://git-wip-us.apache.org/repos/asf/tomee/blob/7ffcb012/container/openejb-loader/src/main/java/org/apache/openejb/observer/ObserverManager.java ---------------------------------------------------------------------- diff --git a/container/openejb-loader/src/main/java/org/apache/openejb/observer/ObserverManager.java b/container/openejb-loader/src/main/java/org/apache/openejb/observer/ObserverManager.java index ebd16de..462a46c 100644 --- a/container/openejb-loader/src/main/java/org/apache/openejb/observer/ObserverManager.java +++ b/container/openejb-loader/src/main/java/org/apache/openejb/observer/ObserverManager.java @@ -43,18 +43,23 @@ import java.util.logging.Logger; public class ObserverManager { - private static final ThreadLocal<Set<Invocation>> seen = new ThreadLocal<Set<Invocation>>() { + private static final ThreadLocal<Set<Invocation>> SEEN = new ThreadLocal<Set<Invocation>>() { @Override protected Set<Invocation> initialValue() { - return new HashSet<Invocation>(); + return new HashSet<>(); } }; // lazy init since it is used in SystemInstance private static final AtomicReference<Logger> LOGGER = new AtomicReference<Logger>(); - private final Set<Observer> observers = new LinkedHashSet<Observer>(); - private final Map<Class, Invocation> methods = new ConcurrentHashMap<Class, Invocation>(); + private final Set<Observer> observers = new LinkedHashSet<>(); + private final Map<Class, Invocation> methods = new ConcurrentHashMap<>(); + /** + * + * @param observer Object + * @return boolean + */ public boolean addObserver(final Object observer) { if (observer == null) { throw new IllegalArgumentException("observer cannot be null"); @@ -74,6 +79,11 @@ public class ObserverManager { } } + /** + * + * @param observer Object + * @return boolean + */ public boolean removeObserver(final Object observer) { if (observer == null) { throw new IllegalArgumentException("listener cannot be null"); @@ -99,7 +109,7 @@ public class ObserverManager { try { return doFire(event); } finally { - seen.remove(); + SEEN.remove(); } } @@ -168,17 +178,13 @@ public class ObserverManager { } } - if (list.getInvocations().size() == 0) { - - return IGNORE; - - } else if (list.getInvocations().size() == 1) { - - return list.getInvocations().get(0); - - } else { - - return list; + switch (list.getInvocations().size()) { + case 0: + return IGNORE; + case 1: + return list.getInvocations().get(0); + default: + return list; } } @@ -187,9 +193,9 @@ public class ObserverManager { */ public class Observer { - private final Map<Class, Invocation> before = new ConcurrentHashMap<Class, Invocation>(); - private final Map<Class, Invocation> methods = new ConcurrentHashMap<Class, Invocation>(); - private final Map<Class, Invocation> after = new ConcurrentHashMap<Class, Invocation>(); + private final Map<Class, Invocation> before = new ConcurrentHashMap<>(); + private final Map<Class, Invocation> methods = new ConcurrentHashMap<>(); + private final Map<Class, Invocation> after = new ConcurrentHashMap<>(); private final Object observer; public Observer(final Object observer) { @@ -197,7 +203,7 @@ public class ObserverManager { throw new IllegalArgumentException("observer cannot be null"); } - final Set<Method> methods = new HashSet<Method>(); + final Set<Method> methods = new HashSet<>(); methods.addAll(Arrays.asList(observer.getClass().getMethods())); methods.addAll(Arrays.asList(observer.getClass().getDeclaredMethods())); @@ -315,14 +321,30 @@ public class ObserverManager { } } + /** + * + * @param event Phase + * @param eventType Class + * @return Invocation + */ public Invocation get(final Phase event, final Class eventType) { return get(map(event), eventType); } + /** + * + * @param eventType Class + * @return Invocation + */ public Invocation getAfter(final Class eventType) { return get(after, eventType); } + /** + * + * @param eventType Class + * @return + */ public Invocation getBefore(final Class eventType) { return get(before, eventType); } @@ -395,17 +417,26 @@ public class ObserverManager { private final Method method; private final Object observer; + /** + * + * @param method Method + * @param observer Object + */ public MethodInvocation(final Method method, final Object observer) { this.method = method; this.observer = observer; } + /** + * + * @param event Object + */ @Override public void invoke(final Object event) { try { method.invoke(observer, event); } catch (final InvocationTargetException e) { - if (!seen.get().add(this)) { + if (!SEEN.get().add(this)) { return; } @@ -505,16 +536,29 @@ public class ObserverManager { public static class InvocationList implements Invocation { - private final List<Invocation> invocations = new LinkedList<Invocation>(); + private final List<Invocation> invocations = new LinkedList<>(); + /** + * + * @param invocation Invocation + * @return boolean + */ public boolean add(final Invocation invocation) { return invocations.add(invocation); } + /** + * + * @return + */ public List<Invocation> getInvocations() { return invocations; } + /** + * + * @param event Object + */ @Override public void invoke(final Object event) { for (final Invocation invocation : invocations) { http://git-wip-us.apache.org/repos/asf/tomee/blob/7ffcb012/container/openejb-loader/src/main/java/org/apache/openejb/observer/event/ObserverAdded.java ---------------------------------------------------------------------- diff --git a/container/openejb-loader/src/main/java/org/apache/openejb/observer/event/ObserverAdded.java b/container/openejb-loader/src/main/java/org/apache/openejb/observer/event/ObserverAdded.java index 87dbd74..279a17e 100644 --- a/container/openejb-loader/src/main/java/org/apache/openejb/observer/event/ObserverAdded.java +++ b/container/openejb-loader/src/main/java/org/apache/openejb/observer/event/ObserverAdded.java @@ -26,10 +26,18 @@ public class ObserverAdded { private final Object observer; + /** + * + * @param observer Object + */ public ObserverAdded(final Object observer) { this.observer = observer; } + /** + * + * @return Object + */ public Object getObserver() { return observer; } http://git-wip-us.apache.org/repos/asf/tomee/blob/7ffcb012/container/openejb-loader/src/main/java/org/apache/openejb/observer/event/ObserverFailed.java ---------------------------------------------------------------------- diff --git a/container/openejb-loader/src/main/java/org/apache/openejb/observer/event/ObserverFailed.java b/container/openejb-loader/src/main/java/org/apache/openejb/observer/event/ObserverFailed.java index 83beb49..dabec53 100644 --- a/container/openejb-loader/src/main/java/org/apache/openejb/observer/event/ObserverFailed.java +++ b/container/openejb-loader/src/main/java/org/apache/openejb/observer/event/ObserverFailed.java @@ -34,6 +34,13 @@ public class ObserverFailed { private final Throwable throwable; + /** + * + * @param observer Object + * @param method Method + * @param event Object + * @param throwable Throwable + */ public ObserverFailed(final Object observer, final Method method, final Object event, final Throwable throwable) { this.observer = observer; this.event = event; @@ -41,18 +48,34 @@ public class ObserverFailed { this.throwable = throwable; } + /** + * + * @return Method + */ public Method getMethod() { return method; } + /** + * + * @return Object + */ public Object getObserver() { return observer; } + /** + * + * @return Object + */ public Object getEvent() { return event; } + /** + * + * @return Throwable + */ public Throwable getThrowable() { return throwable; } http://git-wip-us.apache.org/repos/asf/tomee/blob/7ffcb012/container/openejb-loader/src/main/java/org/apache/openejb/observer/event/ObserverRemoved.java ---------------------------------------------------------------------- diff --git a/container/openejb-loader/src/main/java/org/apache/openejb/observer/event/ObserverRemoved.java b/container/openejb-loader/src/main/java/org/apache/openejb/observer/event/ObserverRemoved.java index f33efa3..d06eba1 100644 --- a/container/openejb-loader/src/main/java/org/apache/openejb/observer/event/ObserverRemoved.java +++ b/container/openejb-loader/src/main/java/org/apache/openejb/observer/event/ObserverRemoved.java @@ -26,10 +26,18 @@ public class ObserverRemoved { private final Object observer; + /** + * + * @param observer Object + */ public ObserverRemoved(final Object observer) { this.observer = observer; } + /** + * + * @return Object + */ public Object getObserver() { return observer; }
