Skip to content

Commit

Permalink
more javadoc fixes #2056
Browse files Browse the repository at this point in the history
Signed-off-by: olivier lamy <olamy@webtide.com>
  • Loading branch information
olamy committed Jan 9, 2018
1 parent 041a326 commit 5a323a0
Show file tree
Hide file tree
Showing 12 changed files with 23 additions and 24 deletions.
Expand Up @@ -838,12 +838,10 @@ protected Key makeKey (String id, SessionContext context)
/**
* Check to see if indexes are available, in which case
* 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
{
Query<ProjectionEntity> query = Query.newProjectionEntityQueryBuilder()
Expand Down
Expand Up @@ -183,7 +183,7 @@ public static Server applyXmlConfigurations (Server server, List<File> files, Ma
if (files == null || files.isEmpty())
return server;

Map<String,Object> lastMap = new HashMap<String,Object>();
Map<String,Object> lastMap = new HashMap<>();

if (server != null)
lastMap.put("Server", server);
Expand Down Expand Up @@ -231,7 +231,7 @@ public static Server applyXmlConfigurations (Server server, List<File> files, Ma
* @param files the xml configs to apply
* @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)
throws Exception
Expand Down
Expand Up @@ -240,7 +240,7 @@ private List<String> fromCSV (String csv)
}

/**
* @param args
* @param args Starter arguments
*/
public static final void main(String[] args)
{
Expand Down
Expand Up @@ -53,7 +53,7 @@ public class WebAppPropertyConverter
* @param webApp the webapp to convert
* @param propsFile the file to put the properties into
* @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)
throws Exception
Expand Down Expand Up @@ -114,7 +114,7 @@ public static void toProperties(JettyWebAppContext webApp, File propsFile, Strin

//web-inf lib
List<File> deps = webApp.getWebInfLib();
StringBuffer strbuff = new StringBuffer();
StringBuilder strbuff = new StringBuilder();
if (deps != null)
{
for (int i=0; i<deps.size(); i++)
Expand Down Expand Up @@ -146,7 +146,7 @@ public static void toProperties(JettyWebAppContext webApp, File propsFile, Strin
* @param resource the properties file to apply
* @param server the Server instance to use
* @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)
throws Exception
Expand All @@ -164,7 +164,7 @@ public static void fromProperties (JettyWebAppContext webApp, String resource, S
* @param propsFile the properties 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
* @throws Exception
* @throws Exception if any I/O exception occurs
*/
public static void fromProperties (JettyWebAppContext webApp, File propsFile, Server server, Map<String,String> jettyProperties)
throws Exception
Expand Down Expand Up @@ -251,7 +251,7 @@ public static void fromProperties (JettyWebAppContext webApp, File propsFile, Se
//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
//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))
{
XmlConfiguration xmlConfiguration = new XmlConfiguration(Resource.newResource(str).getURI().toURL());
Expand Down
Expand Up @@ -87,7 +87,7 @@ public XMemcachedClientBuilder getBuilder()


/**
* @param sec
* @param sec the expiry to use in seconds
*/
public void setExpirySec (int sec)
{
Expand Down
Expand Up @@ -126,8 +126,7 @@ public void setCollectionName(String collectionName)


/**
* @throws MongoException
* @throws UnknownHostException
* @throws Exception {@link UnknownHostException} if any issue while resolving MongoDB Host
* @see org.eclipse.jetty.server.session.SessionDataStoreFactory#getSessionDataStore(org.eclipse.jetty.server.session.SessionHandler)
*/
@Override
Expand Down
Expand Up @@ -146,7 +146,7 @@ else if (pattern != null && pattern.matcher(bundle.getSymbolicName()).matches())

/**
* Check that jsp is on the classpath
* @return
* @return <code>true</code> if jsp is available in the environment
*/
public boolean isJspAvailable()
{
Expand Down Expand Up @@ -195,7 +195,7 @@ public void fixJspFactory ()
/**
* Find the bundle that contains a jstl implementation class, which assumes that
* the jstl taglibs will be inside the same bundle.
* @return
* @return Bundle contains the jstl implementation class
*/
public Bundle findJstlBundle ()
{
Expand Down
Expand Up @@ -120,7 +120,7 @@ public JSTLBundleDiscoverer()
* Unsupported: the bundle is a jar that embeds more jars.
*
* @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
{
Expand Down
Expand Up @@ -39,7 +39,7 @@ public class WarUrlActivator implements BundleActivator
/**
* Register the url stream handler factory.
*
* @param context
* @param context the {@link BundleContext} to use
*/
@SuppressWarnings("unchecked")
public void start(BundleContext context) throws Exception
Expand Down
Expand Up @@ -52,6 +52,7 @@ public class WarURLConnection extends URLConnection
* a new temporary file ust to replace the manifest.
* @param newmanifest The new manifest
* @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,
final InputStream rawIn) throws IOException
Expand Down Expand Up @@ -106,6 +107,7 @@ public void run()
* @param url The file url (for example)
* @param mf The manifest to use as a replacement to the jar file inside
* the file url.
* @throws IOException if an I/O error occurs.
*/
public WarURLConnection(URL url, Manifest mf) throws IOException
{
Expand Down
Expand Up @@ -33,10 +33,10 @@ public interface TldBundleDiscoverer
/**
* Find bundles that contain tlds and convert into URL references to their location.
*
* @param manager
* @param fileLocator
* @param manager The {@link DeploymentManager} instance to use
* @param fileLocator the {@link BundleFileLocatorHelper} instance to use
* @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;

Expand Down
Expand Up @@ -42,12 +42,12 @@ public class Util
/**
* 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 managedServerName the name of the jetty server instance
* @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
{
Expand Down

0 comments on commit 5a323a0

Please sign in to comment.