more javadoc fixes #2056

Signed-off-by: olivier lamy <olamy@webtide.com>
This commit is contained in:
olivier lamy 2018-01-09 13:35:58 +11:00
parent 041a3260b6
commit 5a323a01dd
12 changed files with 23 additions and 24 deletions

View File

@ -838,12 +838,10 @@ public class GCloudSessionDataStore extends AbstractSessionDataStore
/** /**
* Check to see if indexes are available, in which case * Check to see if indexes are available, in which case
* we can do more performant queries. * we can do more performant queries.
* @return * @return <code>true</code> if indexes are available
*/ */
protected boolean checkIndexes () protected boolean checkIndexes()
{ {
long start =0;
try try
{ {
Query<ProjectionEntity> query = Query.newProjectionEntityQueryBuilder() Query<ProjectionEntity> query = Query.newProjectionEntityQueryBuilder()

View File

@ -183,7 +183,7 @@ public class ServerSupport
if (files == null || files.isEmpty()) if (files == null || files.isEmpty())
return server; return server;
Map<String,Object> lastMap = new HashMap<String,Object>(); Map<String,Object> lastMap = new HashMap<>();
if (server != null) if (server != null)
lastMap.put("Server", server); lastMap.put("Server", server);
@ -231,7 +231,7 @@ public class ServerSupport
* @param files the xml configs to apply * @param files the xml configs to apply
* @return the Server after application of configs * @return the Server after application of configs
* *
* @throws Exception * @throws Exception if unable to apply the xml configuration
*/ */
public static Server applyXmlConfigurations (Server server, List<File> files) public static Server applyXmlConfigurations (Server server, List<File> files)
throws Exception throws Exception

View File

@ -240,7 +240,7 @@ public class Starter
} }
/** /**
* @param args * @param args Starter arguments
*/ */
public static final void main(String[] args) public static final void main(String[] args)
{ {

View File

@ -53,7 +53,7 @@ public class WebAppPropertyConverter
* @param webApp the webapp to convert * @param webApp the webapp to convert
* @param propsFile the file to put the properties into * @param propsFile the file to put the properties into
* @param contextXml the optional context xml file related to the webApp * @param contextXml the optional context xml file related to the webApp
* @throws Exception * @throws Exception if any I/O exception occurs
*/ */
public static void toProperties(JettyWebAppContext webApp, File propsFile, String contextXml) public static void toProperties(JettyWebAppContext webApp, File propsFile, String contextXml)
throws Exception throws Exception
@ -114,7 +114,7 @@ public class WebAppPropertyConverter
//web-inf lib //web-inf lib
List<File> deps = webApp.getWebInfLib(); List<File> deps = webApp.getWebInfLib();
StringBuffer strbuff = new StringBuffer(); StringBuilder strbuff = new StringBuilder();
if (deps != null) if (deps != null)
{ {
for (int i=0; i<deps.size(); i++) for (int i=0; i<deps.size(); i++)
@ -146,7 +146,7 @@ public class WebAppPropertyConverter
* @param resource the properties file to apply * @param resource the properties file to apply
* @param server the Server instance to use * @param server the Server instance to use
* @param jettyProperties jetty properties to use if there is a context xml file to apply * @param jettyProperties jetty properties to use if there is a context xml file to apply
* @throws Exception * @throws Exception if any I/O exception occurs
*/ */
public static void fromProperties (JettyWebAppContext webApp, String resource, Server server, Map<String,String> jettyProperties) public static void fromProperties (JettyWebAppContext webApp, String resource, Server server, Map<String,String> jettyProperties)
throws Exception throws Exception
@ -164,7 +164,7 @@ public class WebAppPropertyConverter
* @param propsFile the properties to apply * @param propsFile the properties to apply
* @param server the Server instance to use if there is a context xml file to apply * @param server the Server instance to use if there is a context xml file to apply
* @param jettyProperties jetty properties to use if there is a context xml file to apply * @param jettyProperties jetty properties to use if there is a context xml file to apply
* @throws Exception * @throws Exception if any I/O exception occurs
*/ */
public static void fromProperties (JettyWebAppContext webApp, File propsFile, Server server, Map<String,String> jettyProperties) public static void fromProperties (JettyWebAppContext webApp, File propsFile, Server server, Map<String,String> jettyProperties)
throws Exception throws Exception
@ -251,7 +251,7 @@ public class WebAppPropertyConverter
//the pom to override the context xml file, but as the other mojos all //the pom to override the context xml file, but as the other mojos all
//configure a WebAppContext in the pom (the <webApp> element), it is //configure a WebAppContext in the pom (the <webApp> element), it is
//already configured by the time the context xml file is applied. //already configured by the time the context xml file is applied.
str = (String)props.getProperty("context.xml"); str = props.getProperty("context.xml");
if (!StringUtil.isBlank(str)) if (!StringUtil.isBlank(str))
{ {
XmlConfiguration xmlConfiguration = new XmlConfiguration(Resource.newResource(str).getURI().toURL()); XmlConfiguration xmlConfiguration = new XmlConfiguration(Resource.newResource(str).getURI().toURL());

View File

@ -87,7 +87,7 @@ public class MemcachedSessionDataMap extends AbstractLifeCycle implements Sessio
/** /**
* @param sec * @param sec the expiry to use in seconds
*/ */
public void setExpirySec (int sec) public void setExpirySec (int sec)
{ {

View File

@ -126,8 +126,7 @@ public class MongoSessionDataStoreFactory extends AbstractSessionDataStoreFactor
/** /**
* @throws MongoException * @throws Exception {@link UnknownHostException} if any issue while resolving MongoDB Host
* @throws UnknownHostException
* @see org.eclipse.jetty.server.session.SessionDataStoreFactory#getSessionDataStore(org.eclipse.jetty.server.session.SessionHandler) * @see org.eclipse.jetty.server.session.SessionDataStoreFactory#getSessionDataStore(org.eclipse.jetty.server.session.SessionHandler)
*/ */
@Override @Override

View File

@ -146,7 +146,7 @@ public class ContainerTldBundleDiscoverer implements TldBundleDiscoverer
/** /**
* Check that jsp is on the classpath * Check that jsp is on the classpath
* @return * @return <code>true</code> if jsp is available in the environment
*/ */
public boolean isJspAvailable() public boolean isJspAvailable()
{ {
@ -195,7 +195,7 @@ public class ContainerTldBundleDiscoverer implements TldBundleDiscoverer
/** /**
* Find the bundle that contains a jstl implementation class, which assumes that * Find the bundle that contains a jstl implementation class, which assumes that
* the jstl taglibs will be inside the same bundle. * the jstl taglibs will be inside the same bundle.
* @return * @return Bundle contains the jstl implementation class
*/ */
public Bundle findJstlBundle () public Bundle findJstlBundle ()
{ {

View File

@ -120,7 +120,7 @@ public class JSTLBundleDiscoverer implements TldBundleDiscoverer
* Unsupported: the bundle is a jar that embeds more jars. * Unsupported: the bundle is a jar that embeds more jars.
* *
* @return array of URLs * @return array of URLs
* @throws Exception * @throws Exception In case of errors during resolving TLDs files
*/ */
public URL[] getUrlsForBundlesWithTlds(DeploymentManager deployer, BundleFileLocatorHelper locatorHelper) throws Exception public URL[] getUrlsForBundlesWithTlds(DeploymentManager deployer, BundleFileLocatorHelper locatorHelper) throws Exception
{ {

View File

@ -39,7 +39,7 @@ public class WarUrlActivator implements BundleActivator
/** /**
* Register the url stream handler factory. * Register the url stream handler factory.
* *
* @param context * @param context the {@link BundleContext} to use
*/ */
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
public void start(BundleContext context) throws Exception public void start(BundleContext context) throws Exception

View File

@ -52,6 +52,7 @@ public class WarURLConnection extends URLConnection
* a new temporary file ust to replace the manifest. * a new temporary file ust to replace the manifest.
* @param newmanifest The new manifest * @param newmanifest The new manifest
* @param rawIn The file input stream or equivalent. not the jar input stream. * @param rawIn The file input stream or equivalent. not the jar input stream.
* @throws IOException if an I/O error occurs.
*/ */
public static InputStream substitueManifest(final Manifest newmanifest, public static InputStream substitueManifest(final Manifest newmanifest,
final InputStream rawIn) throws IOException final InputStream rawIn) throws IOException
@ -106,6 +107,7 @@ public class WarURLConnection extends URLConnection
* @param url The file url (for example) * @param url The file url (for example)
* @param mf The manifest to use as a replacement to the jar file inside * @param mf The manifest to use as a replacement to the jar file inside
* the file url. * the file url.
* @throws IOException if an I/O error occurs.
*/ */
public WarURLConnection(URL url, Manifest mf) throws IOException public WarURLConnection(URL url, Manifest mf) throws IOException
{ {

View File

@ -33,10 +33,10 @@ public interface TldBundleDiscoverer
/** /**
* Find bundles that contain tlds and convert into URL references to their location. * Find bundles that contain tlds and convert into URL references to their location.
* *
* @param manager * @param manager The {@link DeploymentManager} instance to use
* @param fileLocator * @param fileLocator the {@link BundleFileLocatorHelper} instance to use
* @return array of URLs representing locations of tld containing bundles * @return array of URLs representing locations of tld containing bundles
* @throws Exception * @throws Exception In case of errors during resolving TLDs files
*/ */
URL[] getUrlsForBundlesWithTlds(DeploymentManager manager, BundleFileLocatorHelper fileLocator) throws Exception; URL[] getUrlsForBundlesWithTlds(DeploymentManager manager, BundleFileLocatorHelper fileLocator) throws Exception;

View File

@ -42,12 +42,12 @@ public class Util
/** /**
* Create an osgi filter for the given classname and server name. * Create an osgi filter for the given classname and server name.
* *
* @param bundleContext * @param bundleContext the {@link BundleContext} instance to use
* @param classname the class to match on the filter * @param classname the class to match on the filter
* @param managedServerName the name of the jetty server instance * @param managedServerName the name of the jetty server instance
* @return a new filter * @return a new filter
* *
* @throws InvalidSyntaxException * @throws InvalidSyntaxException If the filter contains an invalid string that cannot be parsed.
*/ */
public static Filter createFilter (BundleContext bundleContext, String classname, String managedServerName) throws InvalidSyntaxException public static Filter createFilter (BundleContext bundleContext, String classname, String managedServerName) throws InvalidSyntaxException
{ {