Skip to content

Commit 9b95095

Browse files
ludochgae-java-bot
authored andcommitted
Add package-info.java files for Blobstore, Mail, and Task Queue APIs to improve javadocs.
PiperOrigin-RevId: 819326545 Change-Id: Ibe29e682310f623d945996d00ef8b07decb32a3a
1 parent ce10e87 commit 9b95095

10 files changed

Lines changed: 174 additions & 9 deletions

File tree

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/*
2+
* Copyright 2021 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
/**
18+
/**
19+
* @deprecated as of version 3.0, use {@link
20+
* com.google.appengine.api.blobstore.jakarta} instead.
21+
*/
22+
@Deprecated(since = "3.0.0")
23+
24+
package com.google.appengine.api.blobstore.ee10;

api/src/main/java/com/google/appengine/api/blobstore/jakarta/BlobstoreServiceFactory.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@
1717
package com.google.appengine.api.blobstore.jakarta;
1818

1919

20-
/** Creates {@link BlobstoreService} implementations for java EE 10. */
20+
/** Creates {@link BlobstoreService} implementations for jakarta APIs. */
2121
public final class BlobstoreServiceFactory {
2222

23-
/** Creates a {@code BlobstoreService} for java EE 10. */
23+
/** Creates a {@code BlobstoreService} for jakarta APIs. */
2424
public static BlobstoreService getBlobstoreService() {
2525
return new BlobstoreServiceImpl();
2626
}
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
/*
2+
* Copyright 2021 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
/**
18+
* Provides management and persistent storage of large, immutable byte arrays. This allows
19+
* applications to accept, save, and later serve files of any size.
20+
*
21+
* @see com.google.appengine.api.blobstore.BlobstoreService
22+
* @see <a href="http://cloud.google.com/appengine/docs/java/blobstore/">The Blobstore Java API in
23+
* the <em>Google App Engine Developer's Guide</em></a>.
24+
*/
25+
26+
package com.google.appengine.api.blobstore.jakarta;
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
/*
2+
* Copyright 2021 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
/**
18+
/**
19+
* @deprecated as of version 3.0, use {@link
20+
* com.google.appengine.api.mail.jakarta} instead.
21+
*/
22+
@Deprecated(since = "3.0.0")
23+
package com.google.appengine.api.mail.ee10;
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
/*
2+
* Copyright 2021 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
/**
18+
* Provides a service to send email messages on behalf of administrators or authenticated users,
19+
* also accessible via a <a
20+
* href="http://www.oracle.com/technetwork/java/javamail/index.html">JavaMail</a> interface.
21+
* Receiving messages is not supported via the JavaMail API but is supported via <a
22+
* href="http://cloud.google.com/appengine/docs/java/mail/receiving.html">an HTTP interface</a>.
23+
*
24+
* <p>This low-level API is intended primarily for framework authors. For application developers we
25+
* provide a custom {@code javax.mail.Transport} that allows the standard {@code javax.mail}
26+
* interface to be used to send emails. No special configuration is required to send emails via this
27+
* interface.
28+
*
29+
* <p>The {@link com.google.appengine.api.mail.MailService.Message} class represents a message,
30+
* including sender and recipient information, and possibly attachments as {@link
31+
* com.google.appengine.api.mail.MailService.Attachment} objects. These can be independently created
32+
* via their respective constructors.
33+
*
34+
* <p>Sending a message requires a {@link com.google.appengine.api.mail.MailService} object, created
35+
* by the {@link com.google.appengine.api.mail.MailServiceFactory}. Messages are sent
36+
* asynchronously, so the {@code MailService} methods will
37+
* always succeed immediately. Any errors in the mail message will be returned to the sender's
38+
* address as "bounce" messages.
39+
*
40+
* @see com.google.appengine.api.mail.MailService
41+
* @see <a href="http://cloud.google.com/appengine/docs/java/mail/">The Mail Java API in the
42+
* <em>Google App Engine Developer's Guide</em></a>
43+
* @see <a href="http://www.oracle.com/technetwork/java/javamail/index.html">JavaMail API</a>
44+
*/
45+
package com.google.appengine.api.mail.jakarta;
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
/*
2+
* Copyright 2021 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
/**
18+
/**
19+
* @deprecated as of version 3.0, use {@link
20+
* com.google.appengine.api.taskqueue.jakarta} instead.
21+
*/
22+
@Deprecated(since = "3.0.0")
23+
package com.google.appengine.api.taskqueue.ee10;

api/src/main/java/com/google/appengine/api/taskqueue/jakarta/DeferredTaskContext.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@
2323
import java.util.Map;
2424

2525
/**
26-
* Resources for managing {@link DeferredTask}.
26+
* Resources for managing {@link com.google.appengine.api.taskqueue.DeferredTask}.
2727
*
2828
*/
2929
public class DeferredTaskContext {
30-
/** The content type of a serialized {@link DeferredTask}. */
30+
/** The content type of a serialized {@link com.google.appengine.api.taskqueue.DeferredTask}. */
3131
public static final String RUNNABLE_TASK_CONTENT_TYPE =
3232
"application/x-binary-app-engine-java-runnable-task";
3333

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/*
2+
* Copyright 2021 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
/**
18+
* Provides a mechanism to perform work initiated by a user request, outside of that request.
19+
*
20+
* @see com.google.appengine.api.taskqueue.Queue
21+
* @see <a href="http://cloud.google.com/appengine/docs/java/taskqueue/">The Task Queue Java API in
22+
* the <em>Google App Engine Developer's Guide</em></a>.
23+
*/
24+
package com.google.appengine.api.taskqueue.jakarta;

api/src/main/java/com/google/apphosting/utils/servlet/jakarta/DeferredTaskServlet.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
* &lt;servlet&gt;
4444
* &lt;servlet-name&gt;/_ah/queue/__deferred__&lt;/servlet-name&gt;
4545
* &lt;servlet-class
46-
* &gt;com.google.apphosting.utils.servlet.DeferredTaskServlet&lt;/servlet-class&gt;
46+
* &gt;com.google.apphosting.utils.servlet.jakarta.DeferredTaskServlet&lt;/servlet-class&gt;
4747
* &lt;/servlet&gt;
4848
*
4949
* &lt;servlet-mapping&gt;

kokoro/gcp_ubuntu/publish_javadoc.sh

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ export NAME=appengine-java11-bundled-services
4949
export VERSION=11
5050

5151
sudo apt-get update
52-
sudo apt-get install -y openjdk-17-jdk
53-
sudo update-java-alternatives --set java-1.17.0-openjdk-amd64
54-
export JAVA_HOME="$(update-java-alternatives -l | grep "1.17" | head -n 1 | tr -s " " | cut -d " " -f 3)"
52+
sudo apt-get install -y openjdk-21-jdk
53+
sudo update-java-alternatives --set java-1.21.0-openjdk-amd64
54+
export JAVA_HOME="$(update-java-alternatives -l | grep "1.21" | head -n 1 | tr -s " " | cut -d " " -f 3)"
5555

5656
# Make sure `JAVA_HOME` is set.
5757
echo "JAVA_HOME = $JAVA_HOME"
@@ -68,7 +68,7 @@ cd api
6868

6969
pushd target/docfx-yml
7070

71-
# create metadata for Java11/17
71+
# create metadata for Java11/17/25
7272
python3 -m docuploader create-metadata \
7373
--name appengine-java-gen2-bundled-services \
7474
--version 2.0.0 \

0 commit comments

Comments
 (0)