Permalink
Browse files

Java 8 related javadoc formatting.

Change-Id: Iccba9ac795b9212d878ad39a4d6bff2822c48b78
  • Loading branch information...
pavelbucek committed Jan 6, 2016
1 parent 2d33303 commit 373fab2f47ff06167d6ced8475085004ffbbfd5a
Showing with 642 additions and 660 deletions.
  1. +0 −2 bundles/client-jdk/pom.xml
  2. +0 −2 bundles/client/pom.xml
  3. +30 −25 client/src/main/java/org/glassfish/tyrus/client/ClientManager.java
  4. +35 −38 client/src/main/java/org/glassfish/tyrus/client/ClientProperties.java
  5. +12 −33 client/src/main/java/org/glassfish/tyrus/client/SslContextConfigurator.java
  6. +9 −4 client/src/main/java/org/glassfish/tyrus/client/SslEngineConfigurator.java
  7. +17 −16 client/src/main/java/org/glassfish/tyrus/client/ThreadPoolConfig.java
  8. +4 −4 client/src/main/java/org/glassfish/tyrus/client/auth/AuthConfig.java
  9. +2 −2 client/src/main/java/org/glassfish/tyrus/client/auth/AuthenticationException.java
  10. +3 −3 client/src/main/java/org/glassfish/tyrus/client/auth/Authenticator.java
  11. +1 −1 client/src/main/java/org/glassfish/tyrus/client/auth/Credentials.java
  12. +2 −2 client/src/main/java/org/glassfish/tyrus/client/package-info.java
  13. +3 −3 containers/glassfish/cdi/src/main/java/org/glassfish/tyrus/gf/cdi/CdiComponentProvider.java
  14. +2 −2 containers/glassfish/cdi/src/main/java/org/glassfish/tyrus/gf/cdi/package-info.java
  15. +2 −2 containers/glassfish/ejb/src/main/java/org/glassfish/tyrus/gf/ejb/package-info.java
  16. +4 −4 ...ly-client/src/main/java/org/glassfish/tyrus/container/grizzly/client/GrizzlyClientProperties.java
  17. +11 −12 ...rizzly-client/src/main/java/org/glassfish/tyrus/container/grizzly/client/GrizzlyClientSocket.java
  18. +1 −1 ...rs/grizzly-client/src/main/java/org/glassfish/tyrus/container/grizzly/client/HttpCodecFilter.java
  19. +2 −2 ...ners/grizzly-client/src/main/java/org/glassfish/tyrus/container/grizzly/client/TaskProcessor.java
  20. +2 −2 ...iners/grizzly-client/src/main/java/org/glassfish/tyrus/container/grizzly/client/package-info.java
  21. +3 −3 ...zly-server/src/main/java/org/glassfish/tyrus/container/grizzly/server/GrizzlyServerContainer.java
  22. +2 −2 ...iners/grizzly-server/src/main/java/org/glassfish/tyrus/container/grizzly/server/package-info.java
  23. +2 −2 ...ainers/inmemory/src/main/java/org/glassfish/tyrus/container/inmemory/InMemoryClientContainer.java
  24. +2 −2 containers/inmemory/src/main/java/org/glassfish/tyrus/container/inmemory/package-info.java
  25. +12 −33 ...ers/jdk-client/src/main/java/org/glassfish/tyrus/container/jdk/client/SslContextConfigurator.java
  26. +3 −2 ...ners/jdk-client/src/main/java/org/glassfish/tyrus/container/jdk/client/SslEngineConfigurator.java
  27. +2 −2 containers/jdk-client/src/main/java/org/glassfish/tyrus/container/jdk/client/package-info.java
  28. +1 −2 containers/servlet/pom.xml
  29. +3 −3 containers/servlet/src/main/java/org/glassfish/tyrus/servlet/TyrusHttpUpgradeHandler.java
  30. +2 −2 containers/servlet/src/main/java/org/glassfish/tyrus/servlet/TyrusServletContainerInitializer.java
  31. +2 −2 containers/servlet/src/main/java/org/glassfish/tyrus/servlet/package-info.java
  32. +3 −3 core/src/main/java/org/glassfish/tyrus/core/AnnotatedClassValidityChecker.java
  33. +2 −2 core/src/main/java/org/glassfish/tyrus/core/BaseContainer.java
  34. +1 −4 core/src/main/java/org/glassfish/tyrus/core/Beta.java
  35. +2 −2 core/src/main/java/org/glassfish/tyrus/core/BinaryBuffer.java
  36. +7 −7 core/src/main/java/org/glassfish/tyrus/core/ComponentProvider.java
  37. +8 −6 core/src/main/java/org/glassfish/tyrus/core/ComponentProviderService.java
  38. +3 −3 core/src/main/java/org/glassfish/tyrus/core/DebugContext.java
  39. +2 −2 core/src/main/java/org/glassfish/tyrus/core/InputStreamBuffer.java
  40. +3 −3 core/src/main/java/org/glassfish/tyrus/core/MaskingKeyGenerator.java
  41. +3 −3 core/src/main/java/org/glassfish/tyrus/core/MaxSessions.java
  42. +6 −3 core/src/main/java/org/glassfish/tyrus/core/MessageHandlerManager.java
  43. +2 −2 core/src/main/java/org/glassfish/tyrus/core/MessageTooBigException.java
  44. +3 −3 core/src/main/java/org/glassfish/tyrus/core/OsgiRegistry.java
  45. +7 −7 core/src/main/java/org/glassfish/tyrus/core/ProtocolHandler.java
  46. +2 −2 core/src/main/java/org/glassfish/tyrus/core/ReaderBuffer.java
  47. +25 −15 core/src/main/java/org/glassfish/tyrus/core/ReflectionHelper.java
  48. +3 −4 core/src/main/java/org/glassfish/tyrus/core/RequestContext.java
  49. +30 −35 core/src/main/java/org/glassfish/tyrus/core/ServiceFinder.java
  50. +3 −1 core/src/main/java/org/glassfish/tyrus/core/StrictUtf8.java
  51. +16 −8 core/src/main/java/org/glassfish/tyrus/core/TyrusEndpointWrapper.java
  52. +4 −4 core/src/main/java/org/glassfish/tyrus/core/TyrusRemoteEndpoint.java
  53. +5 −5 core/src/main/java/org/glassfish/tyrus/core/TyrusServerEndpointConfig.java
  54. +9 −9 core/src/main/java/org/glassfish/tyrus/core/TyrusSession.java
  55. +8 −4 core/src/main/java/org/glassfish/tyrus/core/TyrusWebSocket.java
  56. +22 −22 core/src/main/java/org/glassfish/tyrus/core/TyrusWebSocketEngine.java
  57. +13 −6 core/src/main/java/org/glassfish/tyrus/core/Utils.java
  58. +10 −10 core/src/main/java/org/glassfish/tyrus/core/cluster/ClusterContext.java
  59. +4 −4 core/src/main/java/org/glassfish/tyrus/core/cluster/DistributedSession.java
  60. +19 −18 core/src/main/java/org/glassfish/tyrus/core/cluster/RemoteSession.java
  61. +2 −2 core/src/main/java/org/glassfish/tyrus/core/cluster/SessionEventListener.java
  62. +2 −2 core/src/main/java/org/glassfish/tyrus/core/cluster/SessionListener.java
  63. +2 −2 core/src/main/java/org/glassfish/tyrus/core/cluster/package-info.java
  64. +2 −2 core/src/main/java/org/glassfish/tyrus/core/coder/package-info.java
  65. +16 −20 core/src/main/java/org/glassfish/tyrus/core/extension/ExtendedExtension.java
  66. +2 −2 core/src/main/java/org/glassfish/tyrus/core/extension/package-info.java
  67. +16 −17 core/src/main/java/org/glassfish/tyrus/core/frame/Frame.java
  68. +2 −2 core/src/main/java/org/glassfish/tyrus/core/frame/TextFrame.java
  69. +3 −3 core/src/main/java/org/glassfish/tyrus/core/frame/TyrusFrame.java
  70. +2 −2 core/src/main/java/org/glassfish/tyrus/core/frame/package-info.java
  71. +2 −3 core/src/main/java/org/glassfish/tyrus/core/l10n/Localizable.java
  72. +2 −2 core/src/main/java/org/glassfish/tyrus/core/monitoring/ApplicationEventListener.java
  73. +2 −2 core/src/main/java/org/glassfish/tyrus/core/monitoring/EndpointEventListener.java
  74. +2 −2 core/src/main/java/org/glassfish/tyrus/core/monitoring/package-info.java
  75. +2 −2 core/src/main/java/org/glassfish/tyrus/core/package-info.java
  76. +11 −11 core/src/main/java/org/glassfish/tyrus/core/uri/internal/AbstractMultivaluedMap.java
  77. +9 −9 core/src/main/java/org/glassfish/tyrus/core/uri/internal/MultivaluedHashMap.java
  78. +2 −2 core/src/main/java/org/glassfish/tyrus/core/uri/internal/MultivaluedStringMap.java
  79. +3 −3 core/src/main/java/org/glassfish/tyrus/core/uri/internal/PathPattern.java
  80. +3 −6 core/src/main/java/org/glassfish/tyrus/core/uri/internal/PathSegment.java
  81. +4 −4 core/src/main/java/org/glassfish/tyrus/core/uri/internal/PatternWithGroups.java
  82. +6 −11 core/src/main/java/org/glassfish/tyrus/core/uri/internal/UriComponent.java
  83. +17 −27 core/src/main/java/org/glassfish/tyrus/core/uri/internal/UriTemplate.java
  84. +3 −3 core/src/main/java/org/glassfish/tyrus/core/uri/internal/UriTemplateParser.java
  85. +2 −2 core/src/main/java/org/glassfish/tyrus/core/uri/package-info.java
  86. +2 −2 ext/client-cli/src/main/java/org/glassfish/tyrus/ext/client/cli/package-info.java
  87. +14 −14 ext/client-java8/src/main/java/org/glassfish/tyrus/ext/client/java8/SessionBuilder.java
  88. +4 −7 ...n-deflate/src/main/java/org/glassfish/tyrus/ext/extension/deflate/PerMessageDeflateExtension.java
  89. +2 −2 ...sion-deflate/src/main/java/org/glassfish/tyrus/ext/extension/deflate/XWebkitDeflateExtension.java
  90. +2 −2 ext/extension-deflate/src/main/java/org/glassfish/tyrus/ext/extension/deflate/package-info.java
  91. +3 −3 ext/monitoring-jmx/src/main/java/org/glassfish/tyrus/ext/monitoring/jmx/ApplicationMonitor.java
  92. +3 −2 ...onitoring-jmx/src/main/java/org/glassfish/tyrus/ext/monitoring/jmx/EndpointClassNamePathPair.java
  93. +5 −5 ...ring-jmx/src/main/java/org/glassfish/tyrus/ext/monitoring/jmx/SessionAwareApplicationMonitor.java
  94. +3 −3 ...oring-jmx/src/main/java/org/glassfish/tyrus/ext/monitoring/jmx/SessionlessApplicationMonitor.java
  95. +2 −2 ext/monitoring-jmx/src/main/java/org/glassfish/tyrus/ext/monitoring/jmx/package-info.java
  96. +8 −3 pom.xml
  97. +5 −1 samples/btc-xchange/src/main/java/org/glassfish/tyrus/sample/btc/xchange/Market.java
  98. +4 −4 samples/btc-xchange/src/main/java/org/glassfish/tyrus/sample/btc/xchange/MarketEndpoint.java
  99. +2 −2 samples/cdi/src/main/java/org/glassfish/tyrus/sample/cdi/RemoteServiceProgrammatic.java
  100. +2 −2 server/src/main/java/org/glassfish/tyrus/server/Server.java
  101. +7 −8 server/src/main/java/org/glassfish/tyrus/server/TyrusServerContainer.java
  102. +2 −2 server/src/main/java/org/glassfish/tyrus/server/package-info.java
  103. +4 −4 spi/src/main/java/org/glassfish/tyrus/spi/ClientContainer.java
  104. +8 −8 spi/src/main/java/org/glassfish/tyrus/spi/ClientEngine.java
  105. +4 −2 spi/src/main/java/org/glassfish/tyrus/spi/Connection.java
  106. +2 −2 spi/src/main/java/org/glassfish/tyrus/spi/ReadHandler.java
  107. +3 −3 spi/src/main/java/org/glassfish/tyrus/spi/ServerContainer.java
  108. +2 −2 spi/src/main/java/org/glassfish/tyrus/spi/ServerContainerFactory.java
  109. +6 −6 spi/src/main/java/org/glassfish/tyrus/spi/UpgradeRequest.java
  110. +6 −4 spi/src/main/java/org/glassfish/tyrus/spi/UpgradeResponse.java
  111. +2 −2 spi/src/main/java/org/glassfish/tyrus/spi/Writer.java
  112. +9 −4 tests/tools/src/main/java/org/glassfish/tyrus/test/tools/GrizzlyModProxy.java
  113. +6 −4 tests/tools/src/main/java/org/glassfish/tyrus/test/tools/TestContainer.java
@@ -175,7 +175,6 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9</version>
<executions>
<execution>
<phase>package</phase>
@@ -186,7 +185,6 @@
</executions>
<configuration>
<excludePackageNames>*.tests.*,*.sample.*</excludePackageNames>
<failOnError>false</failOnError>
</configuration>
</plugin>
</plugins>
View
@@ -199,7 +199,6 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9</version>
<executions>
<execution>
<phase>package</phase>
@@ -210,7 +209,6 @@
</executions>
<configuration>
<excludePackageNames>*.tests.*,*.sample.*</excludePackageNames>
<failOnError>false</failOnError>
</configuration>
</plugin>
</plugins>
@@ -1,7 +1,7 @@
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2011-2015 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2011-2016 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
@@ -89,7 +89,7 @@
/**
* Property usable in {@link #getProperties()}.
* <p/>
* <p>
* Value must be {@code int} and represents handshake timeout in milliseconds. Default value is 30000 (30 seconds).
*
* @deprecated please use {@link org.glassfish.tyrus.client.ClientProperties#HANDSHAKE_TIMEOUT}.
@@ -99,7 +99,7 @@
/**
* Property usable in {@link #getProperties()}.
* <p/>
* <p>
* Value must be {@link org.glassfish.tyrus.client.ClientManager.ReconnectHandler} instance.
*
* @deprecated please use {@link org.glassfish.tyrus.client.ClientProperties#RECONNECT_HANDLER}.
@@ -109,10 +109,9 @@
/**
* Client-side user property to set proxy URI.
* <p/>
* <p>
* Value is expected to be {@link String} and represent proxy URI. Protocol part is currently ignored
* but must be present ({@link URI#URI(String)} is used for parsing).
* <p/>
* <pre>
* client.getProperties().put(ClientManager.PROXY_URI, "http://my.proxy.com:80");
* client.connectToServer(...);
@@ -126,14 +125,14 @@
/**
* Client-side user property to set additional proxy headers.
* <p/>
* Value is expected to be {@link Map}&lt{@link String}, {@link String}&gt and represent raw http headers
* <p>
* Value is expected to be {@link Map}&lt;{@link String}, {@link String}&gt; and represent raw http headers
* to be added to initial request which is sent to proxy. Key corresponds to header name, value is header
* value.
* <p/>
* <p>
* Sample below demonstrates use of this feature to set preemptive basic proxy authentication:
* <pre>
* final HashMap<String, String> proxyHeaders = new HashMap<String, String>();
* final HashMap&lt;String, String&gt; proxyHeaders = new HashMap&lt;String, String&gt;();
* proxyHeaders.put("Proxy-Authorization", "Basic " +
* Base64Utils.encodeToString("username:password".getBytes(Charset.forName("UTF-8")), false));
*
@@ -152,10 +151,10 @@
/**
* Property usable in {@link #getProperties()} as a key for SSL configuration.
* <p/>
* <p>
* Value is expected to be either {@code org.glassfish.grizzly.ssl.SSLEngineConfigurator} when configuring Grizzly
* client or {@link org.glassfish.tyrus.client.SslEngineConfigurator} when configuring JDK client.
* <p/>
* <p>
* Example configuration for JDK client:
* <pre>
* SslContextConfigurator sslContextConfigurator = new SslContextConfigurator();
@@ -178,7 +177,7 @@
/**
* Default {@link org.glassfish.tyrus.spi.ServerContainerFactory} class name.
* <p/>
* <p>
* Uses Grizzly as transport implementation.
*/
private static final String CONTAINER_PROVIDER_CLASSNAME =
@@ -209,10 +208,11 @@
/**
* Create new {@link ClientManager} instance.
* <p/>
* <p>
* Uses {@link ClientManager#CONTAINER_PROVIDER_CLASSNAME} as container implementation, thus relevant module needs
* to be on classpath. Setting different container is possible via {@link ClientManager#createClient(String)}.
*
* @return created client manager.
* @see ClientManager#createClient(String)
*/
public static ClientManager createClient() {
@@ -221,10 +221,12 @@ public static ClientManager createClient() {
/**
* Create new ClientManager instance on top of provided {@link WebSocketContainer} instance.
* <p/>
* <p>
* Uses {@link ClientManager#CONTAINER_PROVIDER_CLASSNAME} as container implementation, thus relevant module needs
* to be on classpath. Setting different container is possible via {@link ClientManager#createClient(String)}.
*
* @param webSocketContainer websocket container.
* @return created client manager.
* @see ClientManager#createClient(String)
*/
public static ClientManager createClient(WebSocketContainer webSocketContainer) {
@@ -234,6 +236,7 @@ public static ClientManager createClient(WebSocketContainer webSocketContainer)
/**
* Create new ClientManager instance.
*
* @param containerProviderClassName classname of container provider. It will be loaded using context class loader.
* @return new ClientManager instance.
*/
public static ClientManager createClient(String containerProviderClassName) {
@@ -243,6 +246,8 @@ public static ClientManager createClient(String containerProviderClassName) {
/**
* Create new ClientManager instance on top of provided {@link WebSocketContainer} instance.
*
* @param containerProviderClassName classname of container provider. It will be loaded using context class loader.
* @param webSocketContainer websocket container.
* @return new ClientManager instance.
*/
public static ClientManager createClient(String containerProviderClassName, WebSocketContainer webSocketContainer) {
@@ -251,7 +256,7 @@ public static ClientManager createClient(String containerProviderClassName, WebS
/**
* Create new {@link ClientManager} instance.
* <p/>
* <p>
* Uses {@link ClientManager#CONTAINER_PROVIDER_CLASSNAME} as container implementation, thus relevant module needs
* to be on classpath. Setting different container is possible via {@link ClientManager#createClient(String)}}.
*
@@ -387,7 +392,7 @@ public Session connectToServer(Object obj, URI path) throws DeploymentException,
/**
* Non-blocking version of {@link WebSocketContainer#connectToServer(Class, java.net.URI)}.
* <p/>
* <p>
* Only simple checks are performed in the main thread; client container is created in different thread, same
* applies to connecting etc.
*
@@ -409,7 +414,7 @@ public Session connectToServer(Object obj, URI path) throws DeploymentException,
/**
* Non-blocking version of {@link WebSocketContainer#connectToServer(Class, javax.websocket.ClientEndpointConfig,
* java.net.URI)}.
* <p/>
* <p>
* Only simple checks are performed in the main thread; client container is created in different thread, same
* applies to connecting etc.
*
@@ -428,7 +433,7 @@ public Session connectToServer(Object obj, URI path) throws DeploymentException,
/**
* Non-blocking version of {@link WebSocketContainer#connectToServer(javax.websocket.Endpoint,
* javax.websocket.ClientEndpointConfig, java.net.URI)}.
* <p/>
* <p>
* Only simple checks are performed in the main thread; client container is created in different thread, same
* applies to connecting etc.
*
@@ -447,7 +452,7 @@ public Session connectToServer(Object obj, URI path) throws DeploymentException,
/**
* Non-blocking version of {@link WebSocketContainer#connectToServer(Object, java.net.URI)}.
* <p/>
* <p>
* Only simple checks are performed in the main thread; client container is created in different thread, same
* applies to connecting etc.
*
@@ -817,7 +822,7 @@ public void setDefaultMaxSessionIdleTimeout(long defaultMaxSessionIdleTimeout) {
/**
* Container properties.
* <p/>
* <p>
* Used to set container specific configuration as SSL truststore and keystore, HTTP Proxy configuration and
* maximum
* incoming buffer size. These properties cannot be shared among various containers due to constraints in WebSocket
@@ -869,7 +874,7 @@ public void execute(Runnable command) {
/**
* Reconnect handler.
* <p/>
* <p>
* When implementing, be sure that you do have enough logic behind cancelling reconnect feature - even {@link
* javax.websocket.Session#close()} call will be treated just like any other disconnect resulting in reconnect.
*/
@@ -890,7 +895,7 @@ public boolean onDisconnect(CloseReason closeReason) {
/**
* Called when there is a connection failure.
* <p/>
* <p>
* Type of the failure is indicated by {@link Exception} parameter. Be cautious when implementing this method,
* you might easily cause DDoS like behaviour.
*
@@ -903,11 +908,11 @@ public boolean onConnectFailure(Exception exception) {
/**
* Get reconnect delay.
* <p/>
* <p>
* Called after {@link #onDisconnect(CloseReason)} or {@link #onConnectFailure(Exception)} when {@code true} is
* returned. When positive value is returned, next connection attempt will be made after that number of
* seconds.
* <p/>
* <p>
* Default implementation returns {@value #RECONNECT_DELAY}.
*
* @return reconnect delay in seconds.
@@ -976,7 +981,7 @@ public long getDelay() {
/**
* A connection has been terminated -> the number of active clients decreases.
* <p/>
* <p>
* This should be called either when the session is closed or an attempt to connect to the server fails.
*/
void onConnectionTerminated();
Oops, something went wrong.

0 comments on commit 373fab2

Please sign in to comment.