Skip to content

Commit

Permalink
Improved references to The Jakarta Faces Specification Document
Browse files Browse the repository at this point in the history
  • Loading branch information
@BalusC
BalusC committed Dec 10, 2021
1 parent 7f25040 commit 8b0906c
Show file tree
Hide file tree
Showing 42 changed files with 180 additions and 195 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Thanks for your interest in this project.

## Project description

Eclipse Mojarra is an implementation for the Jakarta Faces specification.
Eclipse Mojarra is an implementation for the Jakarta Faces Specification.
Jakarta Faces is a Java specification for building
component-based user interfaces for web applications. It is also a MVC web
framework that simplifies construction of user interfaces (UI) for server-based
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ Pull requests are accepted on following branches:
- [`3.0`][29] (3.0.x)
- [`2.3`][30] (2.3.x)

Note that it's okay to send a PR to the master branch, but this one is for JSF.next and not the current 2.3.x or 3.0.x version.
Note that it's okay to send a PR to the master branch, but this one is for Faces.next and not the current 2.3.x or 3.0.x version.
## Resources
Expand Down
3 changes: 2 additions & 1 deletion impl/src/main/doc/unknown/managed-bean-overview.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@
has been placed into its own specifications, namely Managed Beans and CDI.
</p>

<p>The annotations must be processed as specified in section JSF.11.5.1.</p>
<p>The annotations must be processed as specified in section 11.4.1
"Requirements for scanning of classes for annotations" of the Jakarta Faces Specification Document.</p>


</div>
Expand Down
96 changes: 28 additions & 68 deletions impl/src/main/doc/unknown/overview.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<!--
Copyright (c) 1998, 2020 Oracle and/or its affiliates. All rights reserved.
Copyright (c) 1998, 2021 Oracle and/or its affiliates. All rights reserved.
This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0, which is available at
Expand All @@ -23,10 +23,9 @@
<body bgcolor="white">

<p>Please see the <a href="#overview_description">description</a> for a
list of normative documents in the JavaServer<sup>TM</sup> Faces
Specification.<p>
list of normative documents in the Jakarta Faces Specification.<p>

<p>The Java Server Faces Specification is composed of several documents:</p>
<p>The Jakarta Faces Specification is composed of several documents:</p>

<table border="1" width="80%">

Expand All @@ -51,7 +50,8 @@

<tr class="changed_modified_2_0">

<td><span class="changed_modified_2_0_rev_a changed_modified_2_1 changed_modified_2_2 changed_modified_2_3">The API Javadocs (this document)</span></td>
<td><span class="changed_modified_2_0_rev_a changed_modified_2_1 changed_modified_2_2 changed_modified_2_3 changed_modified_4_0">
The API Javadocs (this document)</span></td>

<td>generated HTML
</td>
Expand All @@ -60,7 +60,8 @@

<tr class="changed_added_2_2">

<td><span class="changed_added_2_2 changed_modified_2_3">faces-config XML Schema Documentation</span></td>
<td><span class="changed_added_2_2 changed_modified_2_3 changed_modified_4_0">
The <code>faces-config</code> XML Schema Documentation</span></td>

<td><a target="_" href="web-facesconfig.html">generated HTML</a> <a target="_" href="web-facesconfig.xsd">xsd</a>
</td>
Expand All @@ -69,7 +70,8 @@

<tr class="changed_added_2_2">

<td><span class="changed_added_2_2 changed_modified_2_3">facelet-taglibrary XML Schema Documentation</span></td>
<td><span class="changed_added_2_2 changed_modified_2_3 changed_modified_4_0">
The <code>facelet-taglibrary</code> XML Schema Documentation</span></td>

<td><a target="_" href="web-facelettaglibrary.html">generated HTML</a> <a target="_" href="web-facelettaglibrary.xsd">xsd</a>
</td>
Expand All @@ -78,7 +80,8 @@

<tr class="changed_added_2_2">

<td><span class="changed_added_2_2">facelet-partialresponse XML Schema Documentation</span></td>
<td><span class="changed_added_2_2 changed_modified_2_3 changed_modified_4_0">
The <code>partial-response</code> XML Schema Documentation</span></td>

<td><a target="_" href="web-partialresponse.html">generated HTML</a> <a target="_" href="web-partialresponse.xsd">xsd</a>
</td>
Expand All @@ -88,35 +91,27 @@

<tr class="changed_modified_2_0">

<td><span class="changed_modified_2_0_rev_a changed_modified_2_2"><span
class="changed_modified_2_1 changed_modified_2_3">The Standard HTML RenderKit
Specification</span></span></td>
<td><span class="changed_modified_2_0_rev_a hanged_modified_2_1 changed_modified_2_2 changed_modified_2_3 changed_modified_4_0">
The Standard HTML RenderKit Specification</span></td>

<td><a target="_" href="../renderkitdocs/index.html">generated HTML</a></td>

</tr>

<tr class="changed_deleted_2_0">

<td>The JSP Taglibarydocs</td>

<td><a target="_" href="../vdldocs/jsp/index.html">generated HTML</a>
</td>

</tr>

<tr class="changed_added_2_0">

<td><span class="changed_modified_2_0_rev_a changed_modified_2_1 changed_modified_2_2 changed_modified_2_3">The Facelets Taglibarydocs</span></td>
<td><span class="changed_modified_2_0_rev_a changed_modified_2_1 changed_modified_2_2 changed_modified_2_3 changed_modified_4_0">
The Facelets VDLDocs</span></td>

<td><a target="_" href="../vdldocs/facelets/index.html">TLDDoc</a> <a target="_" href="../vdldoc/index.html">VDLDoc</a> generated HTML
<td><a target="_" href="../vdldocs/facelets/index.html">VDLDocs</a> <a target="_" href="../vdldoc/index.html">VDLDoc</a> generated HTML
</td>

</tr>

<tr>

<td><span class="changed_added_2_0 changed_modified_2_2 changed_modified_2_3">The JSDoc for the JavaScript API (including Ajax and WebSocket functionality)</span></td>
<td><span class="changed_added_2_0 changed_modified_2_2 changed_modified_2_3 changed_modified_4_0">
The JSDoc for the JavaScript API (including Ajax and WebSocket functionality)</span></td>

<td><a target="_" href="../jsdocs/index.html">generated HTML</a>
</td>
Expand All @@ -126,48 +121,10 @@

<tr class="changed_modified_2_0">

<td><span class="changed_modified_2_0_rev_a changed_modified_2_1 changed_modified_2_2 changed_modified_2_3"><a
name="prose_document">The prose document (only available in official JCP releases and expert group SNAPSHOTs)</a></span></td>

<td><a target="_" href="../[email protected]@.pdf">PDF</a></td>

</tr>

</tbody>

</table>

<p>The following table includes sub-specifications that are not required
to be implemented for compliance with JSF 2.1. Implementations are
strongly recommend to implement these specifications to maximize the
ease of use for the users.</p>

<table border="1">

<colgroup>

<col />
<col width="0*" />

</colgroup>

<thead>

<tr>

<th>Specification Document</th> <th>Available formats</th>

</tr>

</thead>

<tbody>

<tr class="changed_added_2_0">

<td><span class="changed_modified_2_2 changed_deleted_2_3">Faces</span> Managed Bean Annotation Specification For Containers Conforming to Servlet 2.5 and Beyond</td>
<td><span class="changed_modified_2_0_rev_a changed_modified_2_1 changed_modified_2_2 changed_modified_2_3 changed_modified_4_0"><a
name="specification_document">The Jakarta Faces Specification Document (only available in official JCP releases and expert group SNAPSHOTs)</a></span></td>

<td><a target="_" href="../managed-bean-javadocs/index.html">generated HTML</a></td>
<td><a target="_" href="../[email protected]@.pdf">PDF</a></td>

</tr>

Expand All @@ -179,27 +136,30 @@
change notification enabled, the following color codes indicate the
nature of the change. Non color coded change-bars are included in the
non-generated portion of the specification. Please see the preface in
the spec prose document for a list of changes.</p>
the Jakarta Faces Specification Document for a list of changes.</p>

<table>

<tr>

<td class="changed_added_2_0 changed_added_2_0_rev_a changed_added_2_2 changed_added_2_3">Added in this version of the spec
<td class="changed_added_2_0 changed_added_2_0_rev_a changed_added_2_2 changed_added_2_3 changed_added_4_0">
Added in this version of the spec
</td>

</tr>

<tr>

<td class="changed_modified_2_0 changed_modified_2_0_rev_a changed_modified_2_2 changed_modified_2_3">Modified in this version of the spec
<td class="changed_modified_2_0 changed_modified_2_0_rev_a changed_modified_2_2 changed_modified_2_3 changed_modified_4_0">
Modified in this version of the spec
</td>

</tr>

<tr>

<td class="changed_deleted_2_0 changed_deleted_0_rev_a changed_deleted_2_2 changed_deleted_2_3">Deleted or deprecated in this version of the spec
<td class="changed_deleted_2_0 changed_deleted_0_rev_a changed_deleted_2_2 changed_deleted_2_3 changed_deleted_4_0">
Deleted or deprecated in this version of the spec
</td>

</tr>
Expand Down
10 changes: 5 additions & 5 deletions impl/src/main/java/jakarta/faces/application/Application.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@ public abstract class Application {
* <span class="changed_modified_2_2">Return</span> the default {@link ActionListener} to be registered for all
* {@link jakarta.faces.component.ActionSource} components in this application. If not explicitly set, a default
* implementation must be provided that performs the <span class="changed_modified_2_2">functions as specified in the
* section titled "ActionListener Property" in the chapter titled "Application Integration" of the spec prose
* document.</span>
* section 7.1.1 "ActionListener Property" in the chapter 7 "Application Integration" of the
* Jakarta Faces Specification Document.</span>
* </p>
*
* <p>
Expand Down Expand Up @@ -350,7 +350,7 @@ public ProjectStage getProjectStage() {
/**
* <p>
* <span class="changed_modified_2_0_rev_a">Cause</span> an the argument <code>resolver</code> to be added to the
* resolver chain as specified in section 5.5.1 of the Jakarta Faces Specification.
* resolver chain as specified in section 5.5.2 "ELResolver" of the Jakarta Faces Specification Document.
* </p>
*
* <p>
Expand Down Expand Up @@ -773,7 +773,7 @@ public UIComponent createComponent(FacesContext context, String componentType, S
* <p>
* Obtain a reference to the <em>composite component metadata</em> for this composite component by calling
* {@link ViewDeclarationLanguage#getComponentMetadata}, passing the <code>facesContext</code> and
* <code>componentResource</code> arguments to this method. This version of the Jakarta Faces specification uses
* <code>componentResource</code> arguments to this method. This version of the Jakarta Faces Specification uses
* JavaBeans as the API to the component metadata.
* </p>
* </li>
Expand All @@ -794,7 +794,7 @@ public UIComponent createComponent(FacesContext context, String componentType, S
* <p>
* Otherwise, determine if a script based component for this <code>Resource</code> can be found by calling
* {@link ViewDeclarationLanguage#getScriptComponentResource}. If the result is non-<code>null</code>, and is a script
* written in one of the languages listed in 4.3 of the specification prose document, create a
* written in <span class="changed_modified_4_0">a language satisfying the content type <code>text/javascript</code></span>, create a
* <code>UIComponent</code> instance from the script resource.
* </p>
* </li>
Expand Down
8 changes: 4 additions & 4 deletions impl/src/main/java/jakarta/faces/application/ApplicationConfigurationPopulator.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@
*
* <p class="changed_added_2_2">
* This class defines a {@code java.util.ServiceLoader} service which enables programmatic configuration of the Jakarta
* Server Faces runtime using the existing Application Configuration Resources schema. See the section "Application
* Startup Behavior" in the specification prose document for the specification on when and how implementations of this
* Server Faces runtime using the existing Application Configuration Resources schema. See the section 11.3.2 "Application
* Startup Behavior" in the Jakarta Faces Specification Document for the specification on when and how implementations of this
* service are used.
* </p>
*
Expand Down Expand Up @@ -51,8 +51,8 @@ public abstract class ApplicationConfigurationPopulator {
* </p>
*
* <p>
* If the document is made to contain an {@code <ordering>} element, as specified in the section <em>Ordering of
* Artifacts</em> in the specification prose document, the document will be prioritized accordingly. Otherwise, the
* If the document is made to contain an {@code <ordering>} element, as specified in the section 11.3.8 "Ordering of
* Artifacts" in the Jakarta Faces Specification Document, the document will be prioritized accordingly. Otherwise, the
* runtime must place the document in the list of other Application Configuration Resources documents at the "lowest"
* priority, meaning any conflicts that may arise between the argument document and any other Application Configuration
* Resources are resolved in favor of the other document.
Expand Down
6 changes: 4 additions & 2 deletions impl/src/main/java/jakarta/faces/application/NavigationCase.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ public class NavigationCase {

/**
* <p class="changed_added_2_0">
* Construct a new <code>NavigationCase</code> based on the provided arguments. See section 7.4.2 in the Jakarta Faces spec for how a
* Construct a new <code>NavigationCase</code> based on the provided arguments. See section 7.4.2 "Default NavigationHandler Algorithm"
* of the Jakarta Faces Specification Document for how a
* <code>NavigationCase</code> is used by the standard {@link ConfigurableNavigationHandler}
* </p>
*
Expand Down Expand Up @@ -87,7 +88,8 @@ public NavigationCase(String fromViewId, String fromAction, String fromOutcome,

/**
* <p class="changed_added_2_0">
* Construct a new <code>NavigationCase</code> based on the provided arguments. See section 7.4.2 of the spec prose document
* Construct a new <code>NavigationCase</code> based on the provided arguments. See section 7.4.2 "Default NavigationHandler Algorithm"
* of the Jakarta Faces Specification Document
* for how a <code>NavigationCase</code> is used by the standard {@link ConfigurableNavigationHandler}
* </p>
*
Expand Down
30 changes: 15 additions & 15 deletions impl/src/main/java/jakarta/faces/application/ResourceHandler.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@
* <p>
* ResourceHandler defines a path based packaging convention for resources. The default implementation of
* <code>ResourceHandler</code> must support packaging resources in the classpath or in the web application root. See
* section 2.6.1 of the spec prose document <a href="../../../overview-summary.html#prose_document">linked in the
* overview summary</a> for the normative specification of packaging resources.
* section 2.6.1 "Packaging Resources" of the Jakarta Faces Specification Document
* for the normative specification of packaging resources.
* </p>
*
* <p>
Expand Down Expand Up @@ -271,8 +271,8 @@ public abstract class ResourceHandler {
* <div class="changed_added_2_0">
*
* <p>
* The algorithm specified in section 2.6.1.4 of the spec prose document
* <a href="../../../overview-summary.html#prose_document">linked in the overview summary</a> must be executed to create
* The algorithm specified in section 2.6.1.4 "Libraries of Localized and Versioned Resources" of the Jakarta Faces Specification Document
* must be executed to create
* the <code>Resource</code>. <span class="changed_added_2_2">New requirements were introduced in version 2.2 of the
* specification. For historical reasons, this method operate correctly when the argument {@code resourceName} is of the
* form {@code libraryName/resourceName}, even when {@code resourceName} contains '/' characters. </span>
Expand Down Expand Up @@ -311,8 +311,8 @@ public abstract class ResourceHandler {
*
* <li>
* <p>
* Considering resource library contracts (at the locations specified in the spec prose document section <em>Resource
* Library Contracts</em> in the <em>Request Processing Lifecycle</em> chapter).
* Considering resource library contracts (at the locations specified in the Jakarta Faces Specification Document section 2.7 "Resource
* Library Contracts").
* </p>
* </li>
*
Expand All @@ -324,8 +324,7 @@ public abstract class ResourceHandler {
*
* <li>
* <p>
* Considering faces flows (at the locations specified in the spec prose document section <em>Faces Flows</em> in the
* <em>Using Jakarta Faces in Web Applications</em> chapter).
* Considering faces flows (at the locations specified in the Jakarta Faces Specification Document section 11.3.3 "Faces Flows").
* </p>
* </li>
*
Expand Down Expand Up @@ -421,8 +420,8 @@ public Stream<String> getViewResources(FacesContext facesContext, String path, R
* <div class="changed_added_2_2">
*
* <p>
* The resource must be identified according to the specification in 2.6.1.3 of the spec prose document
* <a href="../../../overview-summary.html#prose_document">linked in the overview summary</a>. New requirements were
* The resource must be identified according to the specification in section 2.6.1.3 "Resource Identifiers"
* of the Jakarta Faces Specification Document. New requirements were
* introduced in version 2.2 of the specification.
* </p>
*
Expand Down Expand Up @@ -451,8 +450,8 @@ public Resource createResourceFromId(String resourceId) {
* <div class="changed_added_2_0">
*
* <p>
* The algorithm specified in section 2.6.1.4 of the spec prose document
* <a href="../../../overview-summary.html#prose_document">linked in the overview summary</a> must be executed to create
* The algorithm specified in section 2.6.1.4 "Libraries of Localized and Versioned Resources" of the Jakarta Faces Specification Document
* must be executed to create
* the <code>Resource</code>. <span class="changed_added_2_2">New requirements were introduced in version 2.2 of the
* specification.</span>
* </p>
Expand Down Expand Up @@ -482,8 +481,8 @@ public Resource createResourceFromId(String resourceId) {
* <div class="changed_added_2_0">
*
* <p>
* The algorithm specified in section 2.6.1.4 of the spec prose document
* <a href="../../../overview-summary.html#prose_document">linked in the overview summary</a> must be executed to create
* The algorithm specified in section 2.6.1.4 "Libraries of Localized and Versioned Resources" of the Jakarta Faces Specification Document
* must be executed to create
* the <code>Resource</code>. <span class="changed_added_2_2">New requirements were introduced in version 2.2 of the
* specification.</span>
* </p>
Expand Down Expand Up @@ -513,7 +512,8 @@ public Resource createResourceFromId(String resourceId) {
* library is found, look for the library without the prefix. This allows developers to avoid duplication of files. For
* example, consider the case where the developer wants to have a resource library containing a localized image resource
* and a non-localized script resource. By checking both locations for the existence of the library, along with other
* spec changes in section 2.6.1.4, this scenario is enabled.</span>
* spec changes in section 2.6.1.4 "Libraries of Localized and Versioned Resources" of the Jakarta Faces Specification Document,
* this scenario is enabled.</span>
* </p>
*
* @param libraryName the library name.
Expand Down
Loading

0 comments on commit 8b0906c

Please sign in to comment.