You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by is...@apache.org on 2020/10/03 18:31:42 UTC
[tomcat] branch master updated: Added Javadoc comments for Java 15
This is an automated email from the ASF dual-hosted git repository.
isapir pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/master by this push:
new a958f03 Added Javadoc comments for Java 15
a958f03 is described below
commit a958f03ced5a533aec9ab9258459e3d81fd9f2b0
Author: Igal Sapir <is...@apache.org>
AuthorDate: Sat Oct 3 11:24:58 2020 -0700
Added Javadoc comments for Java 15
---
java/jakarta/annotation/Priority.java | 4 ++
java/jakarta/annotation/Resource.java | 32 ++++++++++
java/jakarta/annotation/Resources.java | 4 ++
java/jakarta/annotation/security/DeclareRoles.java | 4 ++
java/jakarta/annotation/security/RolesAllowed.java | 4 ++
java/jakarta/annotation/security/RunAs.java | 4 ++
.../annotation/sql/DataSourceDefinition.java | 73 ++++++++++++++++++++++
.../annotation/sql/DataSourceDefinitions.java | 4 ++
8 files changed, 129 insertions(+)
diff --git a/java/jakarta/annotation/Priority.java b/java/jakarta/annotation/Priority.java
index f5b59c1..74dce8b 100644
--- a/java/jakarta/annotation/Priority.java
+++ b/java/jakarta/annotation/Priority.java
@@ -29,5 +29,9 @@ import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Priority {
+
+ /**
+ * @return the int value
+ */
int value();
}
diff --git a/java/jakarta/annotation/Resource.java b/java/jakarta/annotation/Resource.java
index 70b4d76..20cecab 100644
--- a/java/jakarta/annotation/Resource.java
+++ b/java/jakarta/annotation/Resource.java
@@ -27,21 +27,53 @@ import java.lang.annotation.Target;
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Resource {
+
+ /**
+ * The AuthenticationType, either CONTAINER or APPLICATION
+ */
public enum AuthenticationType {
+ /**
+ * Container authentication
+ */
CONTAINER,
+ /**
+ * Application authentication
+ */
APPLICATION
}
+
+ /**
+ * @return a String with the name of the resource
+ */
public String name() default "";
+
/**
* Uses generics since Common Annotations 1.2.
*
* @return The type for instances of this resource
*/
public Class<?> type() default Object.class;
+
+ /**
+ * @return the AuthenticationType of the resource default CONTAINER
+ */
public AuthenticationType authenticationType() default AuthenticationType.CONTAINER;
+
+ /**
+ * @return true (default) if the resource is shareable, or false if not
+ */
public boolean shareable() default true;
+
+ /**
+ * @return a string with the description for the resource
+ */
public String description() default "";
+
+ /**
+ * @return a string with the mappedName of the resource
+ */
public String mappedName() default "";
+
/**
* @since Common Annotations 1.1
*
diff --git a/java/jakarta/annotation/Resources.java b/java/jakarta/annotation/Resources.java
index 12317ed..d595399 100644
--- a/java/jakarta/annotation/Resources.java
+++ b/java/jakarta/annotation/Resources.java
@@ -29,5 +29,9 @@ import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Resources {
+
+ /**
+ * @return a Resource[] with the value of this Resources
+ */
public Resource[] value();
}
diff --git a/java/jakarta/annotation/security/DeclareRoles.java b/java/jakarta/annotation/security/DeclareRoles.java
index e0f93df..0f2eb21 100644
--- a/java/jakarta/annotation/security/DeclareRoles.java
+++ b/java/jakarta/annotation/security/DeclareRoles.java
@@ -29,5 +29,9 @@ import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface DeclareRoles {
+
+ /**
+ * @return a String[] with the roles
+ */
public String[] value();
}
diff --git a/java/jakarta/annotation/security/RolesAllowed.java b/java/jakarta/annotation/security/RolesAllowed.java
index 5c4d14f..9bb62b5 100644
--- a/java/jakarta/annotation/security/RolesAllowed.java
+++ b/java/jakarta/annotation/security/RolesAllowed.java
@@ -29,5 +29,9 @@ import java.lang.annotation.Target;
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface RolesAllowed {
+
+ /**
+ * @return a String[] of the allowed roles
+ */
public String[] value();
}
diff --git a/java/jakarta/annotation/security/RunAs.java b/java/jakarta/annotation/security/RunAs.java
index f980219..33fe276 100644
--- a/java/jakarta/annotation/security/RunAs.java
+++ b/java/jakarta/annotation/security/RunAs.java
@@ -29,5 +29,9 @@ import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface RunAs {
+
+ /**
+ * @return a String with the value for RunAs
+ */
public String value();
}
diff --git a/java/jakarta/annotation/sql/DataSourceDefinition.java b/java/jakarta/annotation/sql/DataSourceDefinition.java
index dd003a7..e4de009 100644
--- a/java/jakarta/annotation/sql/DataSourceDefinition.java
+++ b/java/jakarta/annotation/sql/DataSourceDefinition.java
@@ -27,22 +27,95 @@ import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface DataSourceDefinition {
+
+ /**
+ * @return the className
+ */
String className();
+
+ /**
+ * @return the name
+ */
String name();
+
+ /**
+ * @return the description
+ */
String description() default "";
+
+ /**
+ * @return the url
+ */
String url() default "";
+
+ /**
+ * @return the user
+ */
String user() default "";
+
+ /**
+ * @return the password
+ */
String password() default "";
+
+ /**
+ * @return database name
+ */
String databaseName() default "";
+
+ /**
+ * @return the port number
+ */
int portNumber() default -1;
+
+ /**
+ * @return the server name
+ */
String serverName() default "localhost";
+
+ /**
+ * @return the isolation level
+ */
int isolationLevel() default -1;
+
+ /**
+ * @return true if the data source is transactional
+ */
boolean transactional() default true;
+
+ /**
+ * @return the initial pool size
+ */
int initialPoolSize() default -1;
+
+ /**
+ * @return the max pool size
+ */
int maxPoolSize() default -1;
+
+ /**
+ * @return the min pool size
+ */
int minPoolSize() default -1;
+
+ /**
+ * @return the max idle time
+ */
int maxIdleTime() default -1;
+
+ /**
+ * @return the max statements
+ */
int maxStatements() default -1;
+
+ /**
+ * @return a String[] with the properties
+ */
String[] properties() default {};
+
+ /**
+ * @return the login timeout
+ */
int loginTimeout() default 0;
+
}
diff --git a/java/jakarta/annotation/sql/DataSourceDefinitions.java b/java/jakarta/annotation/sql/DataSourceDefinitions.java
index 23f5a65..d40e357 100644
--- a/java/jakarta/annotation/sql/DataSourceDefinitions.java
+++ b/java/jakarta/annotation/sql/DataSourceDefinitions.java
@@ -27,5 +27,9 @@ import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface DataSourceDefinitions {
+
+ /**
+ * @return a DataSourceDefinition[]
+ */
DataSourceDefinition[] value();
}
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org