提交 86185595 编写于 作者: B Basil Crow

Replace <code>…</code> with {@code …}

上级 63441802
......@@ -600,7 +600,7 @@ public abstract class ExtensionFinder implements ExtensionPoint {
/**
* Returns initial {@link Method} as well as all matching ones found in interfaces.
* This allows to introspect metadata for a method which is both declared in parent class and in implemented
* interface(s). <code>interfaces</code> typically is obtained by {@link ClassUtils#getAllInterfacesAsSet}
* interface(s). {@code interfaces} typically is obtained by {@link ClassUtils#getAllInterfacesAsSet}
*/
Collection<Method> getMethodAndInterfaceDeclarations(Method method, Collection<Class> interfaces) {
final List<Method> methods = new ArrayList<>();
......
......@@ -1718,7 +1718,7 @@ public final class FilePath implements SerializableOnlyOverRemoting {
* if the parameter is -1, this method becomes no-op.
* <p>
* please note mask is expected to be an octal if you use <a href="http://en.wikipedia.org/wiki/Chmod">chmod command line values</a>,
* so preceded by a '0' in java notation, ie <code>chmod(0644)</code>
* so preceded by a '0' in java notation, ie {@code chmod(0644)}
* <p>
* Only supports setting read, write, or execute permissions for the
* owner, group, or others, so the largest permissible value is 0777.
......
......@@ -769,8 +769,8 @@ public abstract class Launcher {
* recorded on the listener.
*
* @param cmd The commands
* @param mask An array of booleans which control whether a cmd element should be masked (<code>true</code>) or
* remain unmasked (<code>false</code>).
* @param mask An array of booleans which control whether a cmd element should be masked ({@code true}) or
* remain unmasked ({@code false}).
* @param workDir The work dir.
*/
protected final void maskedPrintCommandLine(@Nonnull List<String> cmd, @CheckForNull boolean[] mask, @CheckForNull FilePath workDir) {
......
......@@ -159,7 +159,7 @@ import static java.util.logging.Level.*;
*
* <p>
* <b>Setting default Plugin Managers</b>. The default plugin manager in {@code Jenkins} can be replaced by defining a
* System Property (<code>hudson.PluginManager.className</code>). See {@link #createDefault(Jenkins)}.
* System Property ({@code hudson.PluginManager.className}). See {@link #createDefault(Jenkins)}.
* This className should be available on early startup, so it cannot come only from a library
* (e.g. Jenkins module or Extra library dependency in the WAR file project).
* Plugins cannot be used for such purpose.
......
......@@ -595,7 +595,7 @@ public class PluginWrapper implements Comparable<PluginWrapper>, ModelObject {
/**
* Returns the minimum Java version of this plugin, as specified in the plugin metadata.
* Generally coming from the <code>java.level</code> extracted as MANIFEST's metadata with
* Generally coming from the {@code java.level} extracted as MANIFEST's metadata with
* <a href="https://github.com/jenkinsci/plugin-pom/pull/134">this addition on the plugins' parent pom</a>.
*
* @see <a href="https://github.com/jenkinsci/maven-hpi-plugin/pull/75">maven-hpi-plugin#PR-75</a>.
......
......@@ -455,7 +455,7 @@ public final class TcpSlaveAgentListener extends Thread {
}
/**
* Reschedules the <code>TcpSlaveAgentListener</code> on demand. Disables itself after running.
* Reschedules the {@code TcpSlaveAgentListener} on demand. Disables itself after running.
*/
@Extension
@Restricted(NoExternalUse.class)
......
......@@ -185,11 +185,11 @@ public class Util {
}
/**
* Reads the entire contents of the text file at <code>logfile</code> into a
* Reads the entire contents of the text file at {@code logfile} into a
* string using the {@link Charset#defaultCharset() default charset} for
* decoding. If no such file exists, an empty string is returned.
* @param logfile The text file to read in its entirety.
* @return The entire text content of <code>logfile</code>.
* @return The entire text content of {@code logfile}.
* @throws IOException If an error occurs while reading the file.
* @deprecated call {@link #loadFile(java.io.File, java.nio.charset.Charset)}
* instead to specify the charset to use for decoding (preferably
......@@ -202,12 +202,12 @@ public class Util {
}
/**
* Reads the entire contents of the text file at <code>logfile</code> into a
* string using <code>charset</code> for decoding. If no such file exists,
* Reads the entire contents of the text file at {@code logfile} into a
* string using {@code charset} for decoding. If no such file exists,
* an empty string is returned.
* @param logfile The text file to read in its entirety.
* @param charset The charset to use for decoding the bytes in <code>logfile</code>.
* @return The entire text content of <code>logfile</code>.
* @param charset The charset to use for decoding the bytes in {@code logfile}.
* @return The entire text content of {@code logfile}.
* @throws IOException If an error occurs while reading the file.
*/
@Nonnull
......@@ -992,7 +992,7 @@ public class Util {
/**
* Creates an empty file if nonexistent or truncates the existing file.
* Note: The behavior of this method in the case where the file already
* exists is unlike the POSIX <code>touch</code> utility which merely
* exists is unlike the POSIX {@code touch} utility which merely
* updates the file's access and/or modification time.
*/
public static void touch(@Nonnull File file) throws IOException {
......@@ -1610,7 +1610,7 @@ public class Util {
/**
* If this flag is set to true then we will request a garbage collection
* after a deletion failure before we next retry the delete.<br>
* It defaults to <code>false</code> and is ignored unless
* It defaults to {@code false} and is ignored unless
* {@link #DELETION_MAX} is greater than 1.
* <p>
* Setting this flag to true <i>may</i> resolve some problems on Windows,
......
......@@ -42,7 +42,7 @@ import org.jenkinsci.Symbol;
* @since 1.349 - produces search hyperlinks to the http://stacktrace.jenkins-ci.org service
* @since 2.56 - does nothing due to JENKINS-42861
* @deprecated This ConsoleNote used to provide hyperlinks to the
* <code>http://stacktrace.jenkins-ci.org/</code> service, which is dead now (JENKINS-42861).
* {@code http://stacktrace.jenkins-ci.org/} service, which is dead now (JENKINS-42861).
* This console note does nothing right now.
*/
@Deprecated
......
......@@ -860,7 +860,7 @@ public abstract class AbstractItem extends Actionable implements Item, HttpDelet
/**
* Updates an Item by its XML definition.
* @param source source of the Item's new definition.
* The source should be either a <code>StreamSource</code> or a <code>SAXSource</code>, other
* The source should be either a {@code StreamSource} or a {@code SAXSource}, other
* sources may not be handled.
* @since 1.473
*/
......
......@@ -322,7 +322,7 @@ public abstract class Actionable extends AbstractModelObject implements ModelObj
* Gets the action (first instance to be found) of a specified type that contributed to this build.
*
* @param type
* @return The action or <code>null</code> if no such actions exist.
* @return The action or {@code null} if no such actions exist.
* @see #getActions(Class)
*/
public <T extends Action> T getAction(Class<T> type) {
......
......@@ -84,11 +84,11 @@ public class HealthReport implements Serializable, Comparable<HealthReport> {
private String iconClassName;
/**
* The path to the icon corresponding to this health score or <code>null</code> to use the default icon
* The path to the icon corresponding to this health score or {@code null} to use the default icon
* corresponding to the current health score.
* <p>
* If the path begins with a '/' then it will be the absolute path, otherwise the image is assumed to be in one of
* <code>/images/16x16/</code>, <code>/images/24x24/</code> or <code>/images/32x32/</code> depending on the icon
* {@code /images/16x16/}, {@code /images/24x24/} or {@code /images/32x32/} depending on the icon
* size selected by the user.
*/
private String iconUrl;
......@@ -110,12 +110,12 @@ public class HealthReport implements Serializable, Comparable<HealthReport> {
* Create a new HealthReport.
*
* @param score The percentage health score (from 0 to 100 inclusive).
* @param iconUrl The path to the icon corresponding to this {@link Action}'s health or <code>null</code> to
* @param iconUrl The path to the icon corresponding to this {@link Action}'s health or {@code null} to
* display the default icon corresponding to the current health score.
* <p>
* If the path begins with a '/' then it will be the absolute path, otherwise the image is
* assumed to be in one of <code>/images/16x16/</code>, <code>/images/24x24/</code> or
* <code>/images/32x32/</code> depending on the icon size selected by the user.
* assumed to be in one of {@code /images/16x16/}, {@code /images/24x24/} or
* {@code /images/32x32/} depending on the icon size selected by the user.
* When calculating the url to display for absolute paths, the getIconUrl(String) method
* will replace /32x32/ in the path with the appropriate size.
* @param description The health icon's tool-tip.
......@@ -131,12 +131,12 @@ public class HealthReport implements Serializable, Comparable<HealthReport> {
* Create a new HealthReport.
*
* @param score The percentage health score (from 0 to 100 inclusive).
* @param iconUrl The path to the icon corresponding to this {@link Action}'s health or <code>null</code> to
* @param iconUrl The path to the icon corresponding to this {@link Action}'s health or {@code null} to
* display the default icon corresponding to the current health score.
* <p>
* If the path begins with a '/' then it will be the absolute path, otherwise the image is
* assumed to be in one of <code>/images/16x16/</code>, <code>/images/24x24/</code> or
* <code>/images/32x32/</code> depending on the icon size selected by the user.
* assumed to be in one of {@code /images/16x16/}, {@code /images/24x24/} or
* {@code /images/32x32/} depending on the icon size selected by the user.
* When calculating the url to display for absolute paths, the getIconUrl(String) method
* will replace /32x32/ in the path with the appropriate size.
* @param description The health icon's tool-tip.
......
......@@ -43,7 +43,7 @@ public interface HealthReportingAction extends Action {
*
* @return
* The health report for this instance of the Action or
* <code>null</code> if the Action does not want to
* {@code null} if the Action does not want to
* contribute a HealthReport.
*/
HealthReport getBuildHealth();
......
......@@ -282,8 +282,8 @@ public class Items {
* Computes the relative name of list of items after a rename or move occurred.
* Used to manage job references as names in plugins to support {@link hudson.model.listeners.ItemListener#onLocationChanged}.
* <p>
* In a hierarchical context, when a plugin has a reference to a job as <code>../foo/bar</code> this method will
* handle the relative path as "foo" is renamed to "zot" to compute <code>../zot/bar</code>
* In a hierarchical context, when a plugin has a reference to a job as {@code ../foo/bar} this method will
* handle the relative path as "foo" is renamed to "zot" to compute {@code ../zot/bar}
*
* @param oldFullName the old full name of the item
* @param newFullName the new full name of the item
......
......@@ -180,7 +180,7 @@ public abstract class Node extends AbstractModelObject implements Reconfigurable
/**
* Returns the number of {@link Executor}s.
*
* This may be different from <code>getExecutors().size()</code>
* This may be different from {@code getExecutors().size()}
* because it takes time to adjust the number of executors.
*/
@Exported
......
......@@ -140,7 +140,7 @@ import org.kohsuke.stapler.interceptor.RequirePOST;
* for more information.
* <p>
* <b>Extending Update Centers</b>. The update center in {@code Jenkins} can be replaced by defining a
* System Property (<code>hudson.model.UpdateCenter.className</code>). See {@link #createUpdateCenter(hudson.model.UpdateCenter.UpdateCenterConfiguration)}.
* System Property ({@code hudson.model.UpdateCenter.className}). See {@link #createUpdateCenter(hudson.model.UpdateCenter.UpdateCenterConfiguration)}.
* This className should be available on early startup, so it cannot come only from a library
* (e.g. Jenkins module or Extra library dependency in the WAR file project).
* Plugins cannot be used for such purpose.
......
......@@ -587,13 +587,13 @@ public class User extends AbstractModelObject implements AccessControlled, Descr
}
/**
* Gets the {@link User} object by its <code>id</code>
* Gets the {@link User} object by its {@code id}
*
* @param id the id of the user to retrieve and optionally create if it does not exist.
* @param create If <code>true</code>, this method will never return <code>null</code> for valid input (by creating a
* new {@link User} object if none exists.) If <code>false</code>, this method will return
* <code>null</code> if {@link User} object with the given id doesn't exist.
* @return the a User whose id is <code>id</code>, or <code>null</code> if <code>create</code> is <code>false</code>
* @param create If {@code true}, this method will never return {@code null} for valid input (by creating a
* new {@link User} object if none exists.) If {@code false}, this method will return
* {@code null} if {@link User} object with the given id doesn't exist.
* @return the a User whose id is {@code id}, or {@code null} if {@code create} is {@code false}
* and the user does not exist.
* @since 1.651.2 / 2.3
*/
......@@ -1114,7 +1114,7 @@ public class User extends AbstractModelObject implements AccessControlled, Descr
/**
* extract user ID from idOrFullName with help from contextual infos.
* can return <code>null</code> if no user ID matched the input
* can return {@code null} if no user ID matched the input
*/
public abstract @CheckForNull String resolveCanonicalId(String idOrFullName, Map<String, ?> context);
......
......@@ -1206,7 +1206,7 @@ public abstract class View extends AbstractModelObject implements AccessControll
/**
* Updates the View with the new XML definition.
* @param source source of the Item's new definition.
* The source should be either a <code>StreamSource</code> or <code>SAXSource</code>, other sources
* The source should be either a {@code StreamSource} or {@code SAXSource}, other sources
* may not be handled.
*/
public void updateByXml(Source source) throws IOException {
......
......@@ -38,9 +38,9 @@ import org.kohsuke.stapler.StaplerRequest;
* persisted with the view object.
*
* <p>
* Configuration screen should be defined in <code>config.jelly</code>.
* Configuration screen should be defined in {@code config.jelly}.
* Within this page, the {@link ViewProperty} instance is available as
* the <code>instance</code> EL variable (while the <code>it</code> EL variable
* the {@code instance} EL variable (while the {@code it} EL variable
* refers to the {@link View}.
*
* @author Stephen Connolly
......
......@@ -46,7 +46,7 @@ public abstract class WorkspaceBrowser implements ExtensionPoint {
/**
* Provide access to job's workspace
* @param job
* @return <code>null</code> if this WorkspaceBrowser don't have a workspace for this job
* @return {@code null} if this WorkspaceBrowser don't have a workspace for this job
*/
public abstract @CheckForNull FilePath getWorkspace(Job job);
......
......@@ -33,7 +33,7 @@ import hudson.model.Descriptor;
* Put {@link Extension} on your descriptor implementation to have it auto-registered.
*
* <p>
* When extending this class, override <code>Descriptor.getDisplayName()</code>. In the
* When extending this class, override {@code Descriptor.getDisplayName()}. In the
* context of LabelAtomPropertyDescriptor, this function is used to determine the label of
* the checkbox shown in the label's configuration page to activate the extension.
*
......
......@@ -643,7 +643,7 @@ public abstract class SCM implements Describable<SCM>, ExtensionPoint {
* all the module roots that were checked out from SCM.
*
* <p>
* For normal SCMs, the array will be of length <code>1</code> and it's contents
* For normal SCMs, the array will be of length {@code 1} and it's contents
* will be identical to calling {@link #getModuleRoot(FilePath, AbstractBuild)}.
*
* @param workspace The workspace root directory
......
......@@ -515,7 +515,7 @@ public class HudsonPrivateSecurityRealm extends AbstractPasswordBasedSecurityRea
* Creates a new user account by registering a JBCrypt Hashed password with the user.
*
* @param userName The user's name
* @param hashedPassword A hashed password, must begin with <code>#jbcrypt:</code>
* @param hashedPassword A hashed password, must begin with {@code #jbcrypt:}
*/
public User createAccountWithHashedPassword(String userName, String hashedPassword) throws IOException {
if (!PASSWORD_ENCODER.isPasswordHashed(hashedPassword)) {
......
......@@ -33,7 +33,7 @@ public abstract class CloudProvisioningListener implements ExtensionPoint {
* May be null if provisioning for unlabeled builds.
* @param numExecutors The number of executors needed.
*
* @return <code>null</code> if provisioning can proceed, or a
* @return {@code null} if provisioning can proceed, or a
* {@link CauseOfBlockage} reason why it cannot be provisioned.
*/
public CauseOfBlockage canProvision(Cloud cloud, Label label, int numExecutors) {
......@@ -58,7 +58,7 @@ public abstract class CloudProvisioningListener implements ExtensionPoint {
/**
* Called when the {@link NodeProvisioner.PlannedNode#future} completes.
*
* @param plannedNode the plannedNode which resulted in the <code>node</code> being provisioned
* @param plannedNode the plannedNode which resulted in the {@code node} being provisioned
* @param node the node which has been provisioned by the cloud
*/
public void onComplete(NodeProvisioner.PlannedNode plannedNode, Node node) {
......@@ -66,9 +66,9 @@ public abstract class CloudProvisioningListener implements ExtensionPoint {
}
/**
* Called when the <code>node</code>is fully connected in the Jenkins.
* Called when the {@code node}is fully connected in the Jenkins.
*
* @param plannedNode the plannedNode which resulted in the <code>node</code> being provisioned
* @param plannedNode the plannedNode which resulted in the {@code node} being provisioned
* @param node the node which has been provisioned by the cloud
*
* @since 2.37
......@@ -90,7 +90,7 @@ public abstract class CloudProvisioningListener implements ExtensionPoint {
/**
* Called when {@link Jenkins#addNode(Node)} throws an exception.
*
* @param plannedNode the plannedNode which resulted in the <code>node</code> being provisioned
* @param plannedNode the plannedNode which resulted in the {@code node} being provisioned
* @param node the node which has been provisioned by the cloud
* @param t the exception
*
......
......@@ -166,7 +166,7 @@ public abstract class ComputerLauncher extends AbstractDescribableImpl<ComputerL
public static final DescriptorList<ComputerLauncher> LIST = new DescriptorList<>(ComputerLauncher.class);
/**
* Given the output of "java -version" in <code>r</code>, determine if this
* Given the output of "java -version" in {@code r}, determine if this
* version of Java is supported, or throw {@link IOException}.
*
* @param logger
......
......@@ -57,7 +57,7 @@ import javax.annotation.Nonnull;
* {@link NodeProperty}s show up in the configuration screen of a node, and they are persisted with the {@link Node} object.
*
* <p>
* To add UI action to {@link Node}s, i.e. a new link shown in the left side menu on a node page (<code>./computer/&lt;a node&gt;</code>), see instead {@link hudson.model.TransientComputerActionFactory}.
* To add UI action to {@link Node}s, i.e. a new link shown in the left side menu on a node page ({@code ./computer/<a node>}), see instead {@link hudson.model.TransientComputerActionFactory}.
*
*
* <h2>Views</h2>
......@@ -90,7 +90,7 @@ public abstract class NodeProperty<N extends Node> implements ReconfigurableDesc
* Called by the {@link Node} to help determine whether or not it should
* take the given task. Individual properties can return a non-null value
* here if there is some reason the given task should not be run on its
* associated node. By default, this method returns <code>null</code>.
* associated node. By default, this method returns {@code null}.
*
* @since 1.360
* @deprecated as of 1.413
......@@ -105,7 +105,7 @@ public abstract class NodeProperty<N extends Node> implements ReconfigurableDesc
* Called by the {@link Node} to help determine whether or not it should
* take the given task. Individual properties can return a non-null value
* here if there is some reason the given task should not be run on its
* associated node. By default, this method returns <code>null</code>.
* associated node. By default, this method returns {@code null}.
*
* @since 1.413
*/
......
......@@ -45,8 +45,8 @@ public class EditDistance {
}
/**
* Finds the string in the <code>group</code> closest to
* <code>key</code> and returns it.
* Finds the string in the {@code group} closest to
* {@code key} and returns it.
*
* @return null if group.length==0.
*/
......
......@@ -41,7 +41,7 @@ public class FileChannelWriter extends Writer {
* <p>Basically, {@link BufferedWriter#flush()} does nothing, so when existing code was rewired to use
* {@link FileChannelWriter#flush()} behind {@link AtomicFileWriter} and that method actually ends up calling
* {@link FileChannel#force(boolean)}, many things started timing out. The main reason is probably because XStream's
* {@link com.thoughtworks.xstream.core.util.QuickWriter} uses <code>flush()</code> a lot.
* {@link com.thoughtworks.xstream.core.util.QuickWriter} uses {@code flush()} a lot.
* So we introduced this field to be able to still get a better integrity for the use case of {@link AtomicFileWriter}.
* Because from there, we make sure to call {@link #close()} from {@link AtomicFileWriter#commit()} anyway.
*/
......
......@@ -103,7 +103,7 @@ public class IOUtils {
/**
* See {@link hudson.FilePath#isAbsolute(String)}.
* @param path String representing <code> Platform Specific </code> (unlike FilePath, which may get Platform agnostic paths), may not be null
* @param path String representing {@code Platform Specific } (unlike FilePath, which may get Platform agnostic paths), may not be null
* @return true if String represents absolute path on this platform, false otherwise
*/
public static boolean isAbsolute(String path) {
......
......@@ -98,7 +98,7 @@ public class TextFile {
* Creates a new {@link jenkins.util.io.LinesStream} of the file.
* <p>
* Note: The caller is responsible for closing the returned
* <code>LinesStream</code>.
* {@code LinesStream}.
* @throws IOException if the file cannot be converted to a
* {@link java.nio.file.Path} or if the file cannot be opened for reading
* @since 2.111
......
......@@ -65,7 +65,7 @@ public abstract class ExtensionFilter implements ExtensionPoint {
* type, but the contract type, such as {@link Descriptor}, {@link AdministrativeMonitor}, etc.
* @param component the actual discovered {@link hudson.Extension} object.
* @return
* <code>true</code> to let the component into Jenkins. <code>false</code> to drop it and pretend
* {@code true} to let the component into Jenkins. {@code false} to drop it and pretend
* as if it didn't exist. When any one of {@link ExtensionFilter}s veto
* a component, it gets dropped.
*/
......
......@@ -42,7 +42,7 @@ import org.apache.commons.lang.StringUtils;
* include something in a script that call
* to `onSetupWizardInitialized` with a callback, for example:
*
* See <em><code>upgradeWizard.js</code></em> for an example
* See <em>{@code upgradeWizard.js}</em> for an example
*
* @author <a href="mailto:tom.fennelly@gmail.com">tom.fennelly@gmail.com</a>
*/
......
......@@ -462,9 +462,9 @@ public class Jenkins extends AbstractCIBase implements DirectlyModifiableTopLeve
* A file will be created at the very end of the Jenkins initialization process.
* I.e. if the file is present, that means this is *NOT* a fresh startup.
*
* <code>
* {@code
* STARTUP_MARKER_FILE.get(); // returns false if we are on a fresh startup. True for next startups.
* </code>
* }
*/
private transient static FileBoolean STARTUP_MARKER_FILE;
......@@ -2726,7 +2726,7 @@ public class Jenkins extends AbstractCIBase implements DirectlyModifiableTopLeve
/**
* The strategy used to check the project names.
* @return never <code>null</code>
* @return never {@code null}
*/
public ProjectNamingStrategy getProjectNamingStrategy() {
return projectNamingStrategy == null ? ProjectNamingStrategy.DEFAULT_NAMING_STRATEGY : projectNamingStrategy;
......
......@@ -72,10 +72,10 @@ public abstract class ProjectNamingStrategy implements Describable<ProjectNaming
}
/**
* This flag can be used to force existing jobs to be migrated to a new naming strategy - if this method returns true, the naming will be enforced at every config change. If <code>false</code> is
* This flag can be used to force existing jobs to be migrated to a new naming strategy - if this method returns true, the naming will be enforced at every config change. If {@code false} is
* returned, only new jobs have to follow the strategy.
*
* @return <code>true</code> if existing jobs should be enforced to confirm to the naming standard.
* @return {@code true} if existing jobs should be enforced to confirm to the naming standard.
*/
public boolean isForceExistingJobs() {
return false;
......
......@@ -131,13 +131,13 @@ public final class BuildReference<R> {
* Default factory if none other are installed.
* Its behavior can be controlled via the system property {@link DefaultHolderFactory#MODE_PROPERTY}:
* <dl>
* <dt><code>soft</code> (default)
* <dt>{@code soft} (default)
* <dd>Use {@link SoftReference}s. Builds will be kept around so long as memory pressure is not too high.
* <dt><code>weak</code>
* <dt>{@code weak}
* <dd>Use {@link WeakReference}s. Builds will be kept only until the next full garbage collection cycle.
* <dt><code>strong</code>
* <dt>{@code strong}
* <dd>Use strong references. Builds will still be loaded lazily, but once loaded, will not be released.
* <dt><code>none</code>
* <dt>{@code none}
* <dd>Do not hold onto builds at all. Mainly offered as an option for the purpose of reproducing lazy-loading bugs.
* </dl>
*/
......
......@@ -25,7 +25,7 @@ public abstract class GlobalSettingsProvider extends AbstractDescribableImpl<Glo
*
* @param build
* the build to provide the settings for
* @return the filepath to the provided file. <code>null</code> if no settings will be provided.
* @return the filepath to the provided file. {@code null} if no settings will be provided.
*/
public abstract FilePath supplySettings(AbstractBuild<?, ?> build, TaskListener listener);
......@@ -38,7 +38,7 @@ public abstract class GlobalSettingsProvider extends AbstractDescribableImpl<Glo
}
/**
* Convenience method handling all <code>null</code> checks. Provides the path on the (possible) remote settings file.
* Convenience method handling all {@code null} checks. Provides the path on the (possible) remote settings file.
*
* @param settings
* the provider to be used
......@@ -57,7 +57,7 @@ public abstract class GlobalSettingsProvider extends AbstractDescribableImpl<Glo
}
/**
* Convenience method handling all <code>null</code> checks. Provides the path on the (possible) remote settings file.
* Convenience method handling all {@code null} checks. Provides the path on the (possible) remote settings file.
*
* @param provider
* the provider to be used
......
......@@ -24,7 +24,7 @@ public abstract class SettingsProvider extends AbstractDescribableImpl<SettingsP
* Configure maven launcher argument list with adequate settings path. Implementations should be aware that this method might get called multiple times during a build.
*
* @param build
* @return the filepath to the provided file. <code>null</code> if no settings will be provided.
* @return the filepath to the provided file. {@code null} if no settings will be provided.
*/
public abstract FilePath supplySettings(AbstractBuild<?, ?> build, TaskListener listener);
......@@ -37,7 +37,7 @@ public abstract class SettingsProvider extends AbstractDescribableImpl<SettingsP
}
/**
* Convenience method handling all <code>null</code> checks. Provides the path on the (possible) remote settings file.
* Convenience method handling all {@code null} checks. Provides the path on the (possible) remote settings file.
*
* @param settings
* the provider to be used
......@@ -56,7 +56,7 @@ public abstract class SettingsProvider extends AbstractDescribableImpl<SettingsP
}
/**
* Convenience method handling all <code>null</code> checks. Provides the path on the (possible) remote settings file.
* Convenience method handling all {@code null} checks. Provides the path on the (possible) remote settings file.
*
* @param settings
* the provider to be used
......
......@@ -50,11 +50,11 @@ import java.util.Locale;
*
* <ul>
* <li>{@link #isValidInfrastructureTld} - validates infrastructure TLDs
* (<code>.arpa</code>, etc.)</li>
* ({@code .arpa}, etc.)</li>
* <li>{@link #isValidGenericTld} - validates generic TLDs
* (<code>.com, .org</code>, etc.)</li>
* ({@code .com, .org}, etc.)</li>
* <li>{@link #isValidCountryCodeTld} - validates country code TLDs
* (<code>.us, .uk, .cn</code>, etc.)</li>
* ({@code .us, .uk, .cn}, etc.)</li>
* </ul>
*
* <p>
......@@ -149,7 +149,7 @@ public class DomainValidator implements Serializable {
}
/**
* Returns true if the specified <code>String</code> parses
* Returns true if the specified {@code String} parses
* as a valid domain name with a recognized top-level domain.
* The parsing is case-insensitive.
* @param domain the parameter to check for domain name syntax
......@@ -194,7 +194,7 @@ public class DomainValidator implements Serializable {
}
/**
* Returns true if the specified <code>String</code> matches any
* Returns true if the specified {@code String} matches any
* IANA-defined top-level domain. Leading dots are ignored if present.
* The search is case-insensitive.
* @param tld the parameter to check for TLD status, not null
......@@ -211,7 +211,7 @@ public class DomainValidator implements Serializable {
}
/**
* Returns true if the specified <code>String</code> matches any
* Returns true if the specified {@code String} matches any
* IANA-defined infrastructure top-level domain. Leading dots are
* ignored if present. The search is case-insensitive.
* @param iTld the parameter to check for infrastructure TLD status, not null
......@@ -223,7 +223,7 @@ public class DomainValidator implements Serializable {
}
/**
* Returns true if the specified <code>String</code> matches any
* Returns true if the specified {@code String} matches any
* IANA-defined generic top-level domain. Leading dots are ignored
* if present. The search is case-insensitive.
* @param gTld the parameter to check for generic TLD status, not null
......@@ -236,7 +236,7 @@ public class DomainValidator implements Serializable {
}
/**
* Returns true if the specified <code>String</code> matches any
* Returns true if the specified {@code String} matches any
* IANA-defined country code top-level domain. Leading dots are
* ignored if present. The search is case-insensitive.
* @param ccTld the parameter to check for country code TLD status, not null
......@@ -249,7 +249,7 @@ public class DomainValidator implements Serializable {
}
/**
* Returns true if the specified <code>String</code> matches any
* Returns true if the specified {@code String} matches any
* widely used "local" domains (localhost or localdomain). Leading dots are
* ignored if present. The search is case-insensitive.
* @param lTld the parameter to check for local TLD status, not null
......
......@@ -26,7 +26,7 @@ import java.util.Arrays;
import java.util.List;
/**
* <p><b>InetAddress</b> validation and conversion routines (<code>java.net.InetAddress</code>).</p>
* <p><b>InetAddress</b> validation and conversion routines ({@code java.net.InetAddress}).</p>
*
* <p>This class provides methods to validate a candidate IP address.
*
......
......@@ -34,29 +34,29 @@ import java.util.regex.Pattern;
* expressions:
* </p>
* <pre>
* <code>
* {@code
* String[] regexs = new String[] {...};
* RegexValidator validator = new RegexValidator(regexs, false);
* </code>
* }
* </pre>
*
* <ul>
* <li>Validate <code>true</code> or <code>false</code>:</li>
* <li>Validate {@code true} or {@code false}:</li>
* <li>
* <ul>
* <li><code>boolean valid = validator.isValidRootUrl(value);</code></li>
* <li>{@code boolean valid = validator.isValidRootUrl(value);}</li>
* </ul>
* </li>
* <li>Validate returning an aggregated String of the matched groups:</li>
* <li>
* <ul>
* <li><code>String result = validator.validate(value);</code></li>
* <li>{@code String result = validator.validate(value);}</li>
* </ul>
* </li>
* <li>Validate returning the matched groups:</li>
* <li>
* <ul>
* <li><code>String[] result = validator.match(value);</code></li>
* <li>{@code String[] result = validator.match(value);}</li>
* </ul>
* </li>
* </ul>
......@@ -97,7 +97,7 @@ public class RegexValidator implements Serializable {
*
* @param regex The regular expression this validator will
* validate against
* @param caseSensitive when <code>true</code> matching is <i>case
* @param caseSensitive when {@code true} matching is <i>case
* sensitive</i>, otherwise matching is <i>case in-sensitive</i>
*/
public RegexValidator(String regex, boolean caseSensitive) {
......@@ -121,7 +121,7 @@ public class RegexValidator implements Serializable {
*
* @param regexs The set of regular expressions this validator will
* validate against
* @param caseSensitive when <code>true</code> matching is <i>case
* @param caseSensitive when {@code true} matching is <i>case
* sensitive</i>, otherwise matching is <i>case in-sensitive</i>
*/
public RegexValidator(String[] regexs, boolean caseSensitive) {
......@@ -142,8 +142,8 @@ public class RegexValidator implements Serializable {
* Validate a value against the set of regular expressions.
*
* @param value The value to validate.
* @return <code>true</code> if the value is valid
* otherwise <code>false</code>.
* @return {@code true} if the value is valid
* otherwise {@code false}.
*/
public boolean isValid(String value) {
if (value == null) {
......@@ -163,7 +163,7 @@ public class RegexValidator implements Serializable {
*
* @param value The value to validate.
* @return String array of the <i>groups</i> matched if
* valid or <code>null</code> if invalid
* valid or {@code null} if invalid
*/
public String[] match(String value) {
if (value == null) {
......@@ -190,7 +190,7 @@ public class RegexValidator implements Serializable {
*
* @param value The value to validate.
* @return Aggregated String value comprised of the
* <i>groups</i> matched if valid or <code>null</code> if invalid
* <i>groups</i> matched if valid or {@code null} if invalid
*/
public String validate(String value) {
if (value == null) {
......
......@@ -258,7 +258,7 @@ public class UrlValidator implements Serializable {
* This allows the user to override the standard set of domains.
* @param options Validation options. Set using the public constants of this class.
* To set multiple options, simply add them together:
* <p><code>ALLOW_2_SLASHES + NO_FRAGMENTS</code></p>
* <p>{@code ALLOW_2_SLASHES + NO_FRAGMENTS}</p>
* enables both of those options.
*/
public UrlValidator(RegexValidator authorityValidator, long options) {
......@@ -271,7 +271,7 @@ public class UrlValidator implements Serializable {
* @param authorityValidator Regular expression validator used to validate the authority part
* @param options Validation options. Set using the public constants of this class.
* To set multiple options, simply add them together:
* <p><code>ALLOW_2_SLASHES + NO_FRAGMENTS</code></p>
* <p>{@code ALLOW_2_SLASHES + NO_FRAGMENTS}</p>
* enables both of those options.
*/
public UrlValidator(String[] schemes, RegexValidator authorityValidator, long options) {
......@@ -298,7 +298,7 @@ public class UrlValidator implements Serializable {
* Note that the method calls #isValidAuthority()
* which checks that the domain is valid.
*
* @param value The value validation is being performed on. A <code>null</code>
* @param value The value validation is being performed on. A {@code null}
* value is considered invalid.
* @return true if the url is valid.
*/
......@@ -353,7 +353,7 @@ public class UrlValidator implements Serializable {
* then only those schemes are allowed.
* Otherwise the default schemes are "http", "https", "ftp".
* Matching is case-blind.
* @param scheme The scheme to validate. A <code>null</code> value is considered
* @param scheme The scheme to validate. A {@code null} value is considered
* invalid.
* @return true if valid.
*/
......@@ -376,7 +376,7 @@ public class UrlValidator implements Serializable {
/**
* Returns true if the authority is properly formatted. An authority is the combination
* of hostname and port. A <code>null</code> authority value is considered invalid.
* of hostname and port. A {@code null} authority value is considered invalid.
* Note: this implementation validates the domain unless a RegexValidator was provided.
* If a RegexValidator was supplied and it matches, then the authority is regarded
* as valid with no further checks, otherwise the method checks against the
......@@ -443,7 +443,7 @@ public class UrlValidator implements Serializable {
}
/**
* Returns true if the path is valid. A <code>null</code> value is considered invalid.
* Returns true if the path is valid. A {@code null} value is considered invalid.
* @param path Path value to validate.
* @return true if path is valid.
*/
......
......@@ -44,20 +44,20 @@ import java.util.logging.Level;
import java.util.logging.Logger;
/**
* Handles any <code>AccessDeniedException</code> and <code>AuthenticationException</code> thrown within the
* Handles any {@code AccessDeniedException} and {@code AuthenticationException} thrown within the
* filter chain.
* <p>
* This filter is necessary because it provides the bridge between Java exceptions and HTTP responses.
* It is solely concerned with maintaining the user interface. This filter does not do any actual security enforcement.
* </p>
* <p>
* If an {@link AuthenticationException} is detected, the filter will launch the <code>authenticationEntryPoint</code>.
* If an {@link AuthenticationException} is detected, the filter will launch the {@code authenticationEntryPoint}.
* This allows common handling of authentication failures originating from any subclass of
* {@code AbstractSecurityInterceptor}.
* </p>
* <p>
* If an {@link AccessDeniedException} is detected, the filter will determine whether or not the user is an anonymous
* user. If they are an anonymous user, the <code>authenticationEntryPoint</code> will be launched. If they are not
* user. If they are an anonymous user, the {@code authenticationEntryPoint} will be launched. If they are not
* an anonymous user, the filter will delegate to the {@code AccessDeniedHandler}.
* By default the filter will use {@code AccessDeniedHandlerImpl}.
* </p>
......@@ -65,16 +65,16 @@ import java.util.logging.Logger;
* To use this filter, it is necessary to specify the following properties:
* </p>
* <ul>
* <li><code>authenticationEntryPoint</code> indicates the handler that
* <li>{@code authenticationEntryPoint} indicates the handler that
* should commence the authentication process if an
* <code>AuthenticationException</code> is detected. Note that this may also
* {@code AuthenticationException} is detected. Note that this may also
* switch the current protocol from http to https for an SSL login.</li>
* <li><code>portResolver</code> is used to determine the "real" port that a
* <li>{@code portResolver} is used to determine the "real" port that a
* request was received on.</li>
* </ul>
* <P>
* <B>Do not use this class directly.</B> Instead configure
* <code>web.xml</code> to use the {@code FilterToBeanProxy}.
* {@code web.xml} to use the {@code FilterToBeanProxy}.
* </p>
*
* @author Ben Alex
......@@ -171,17 +171,17 @@ public class ExceptionTranslationFilter implements Filter, InitializingBean {
}
/**
* If <code>true</code>, indicates that <code>SecurityEnforcementFilter</code> is permitted to store the target
* URL and exception information in the <code>HttpSession</code> (the default).
* In situations where you do not wish to unnecessarily create <code>HttpSession</code>s - because the user agent
* If {@code true}, indicates that {@code SecurityEnforcementFilter} is permitted to store the target
* URL and exception information in the {@code HttpSession} (the default).
* In situations where you do not wish to unnecessarily create {@code HttpSession}s - because the user agent
* will know the failed URL, such as with BASIC or Digest authentication - you may wish to
* set this property to <code>false</code>. Remember to also set the
* set this property to {@code false}. Remember to also set the
* {@link org.acegisecurity.context.HttpSessionContextIntegrationFilter#allowSessionCreation}
* to <code>false</code> if you set this property to <code>false</code>.
* to {@code false} if you set this property to {@code false}.
*
* @return <code>true</code> if the <code>HttpSession</code> will be
* used to store information about the failed request, <code>false</code>
* if the <code>HttpSession</code> will not be used
* @return {@code true} if the {@code HttpSession} will be
* used to store information about the failed request, {@code false}
* if the {@code HttpSession} will not be used
*/
public boolean isCreateSessionAllowed() {
return createSessionAllowed;
......
......@@ -45,7 +45,7 @@ public class DoActionFilter implements FunctionList.Filter {
* if a method has "do" as name (not possible in pure Java but doable in Groovy or other JVM languages)
* the new system does not consider it as a web method.
* <p>
* Use <code>@WebMethod(name="")</code> or <code>doIndex</code> in such case.
* Use {@code @WebMethod(name="")} or {@code doIndex} in such case.
*/
private static final Pattern DO_METHOD_REGEX = Pattern.compile("^do[^a-z].*");
......
......@@ -56,8 +56,8 @@ import java.util.logging.Logger;
/**
* Extension point for collecting JEP-214 telemetry.
*
* Implementations should provide a <code>description.jelly</code> file with additional details about their purpose and
* behavior which will be included in <code>help-usageStatisticsCollected.jelly</code> for {@link UsageStatistics}.
* Implementations should provide a {@code description.jelly} file with additional details about their purpose and
* behavior which will be included in {@code help-usageStatisticsCollected.jelly} for {@link UsageStatistics}.
*
* @see <a href="https://jenkins.io/jep/214">JEP-214</a>
*
......
......@@ -102,7 +102,7 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
/**
* The URL of the next resource to return in the enumeration. If this
* field is <code>null</code> then the enumeration has been completed,
* field is {@code null} then the enumeration has been completed,
* i.e., there are no more elements to return.
*/
private URL nextResource;
......@@ -123,8 +123,8 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* Indicates whether there are more elements in the enumeration to
* return.
*
* @return <code>true</code> if there are more elements in the
* enumeration; <code>false</code> otherwise.
* @return {@code true} if there are more elements in the
* enumeration; {@code false} otherwise.
*/
public boolean hasMoreElements() {
return (this.nextResource != null);
......@@ -146,9 +146,9 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
/**
* Locates the next resource of the correct name in the classpath and
* sets <code>nextResource</code> to the URL of that resource. If no
* more resources can be found, <code>nextResource</code> is set to
* <code>null</code>.
* sets {@code nextResource} to the URL of that resource. If no
* more resources can be found, {@code nextResource} is set to
* {@code null}.
*/
private void findNextResource() {
URL url = null;
......@@ -266,11 +266,11 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* Creates a classloader for the given project using the classpath given.
*
* @param project The project to which this classloader is to belong.
* Must not be <code>null</code>.
* Must not be {@code null}.
* @param classpath The classpath to use to load the classes. This
* is combined with the system classpath in a manner
* determined by the value of ${build.sysclasspath}.
* May be <code>null</code>, in which case no path
* May be {@code null}, in which case no path
* elements are set up to start with.
*/
public AntClassLoader(Project project, Path classpath) {
......@@ -283,15 +283,15 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* Creates a classloader for the given project using the classpath given.
*
* @param parent The parent classloader to which unsatisfied loading
* attempts are delegated. May be <code>null</code>,
* attempts are delegated. May be {@code null},
* in which case the classloader which loaded this
* class is used as the parent.
* @param project The project to which this classloader is to belong.
* Must not be <code>null</code>.
* Must not be {@code null}.
* @param classpath the classpath to use to load the classes.
* May be <code>null</code>, in which case no path
* May be {@code null}, in which case no path
* elements are set up to start with.
* @param parentFirst If <code>true</code>, indicates that the parent
* @param parentFirst If {@code true}, indicates that the parent
* classloader should be consulted before trying to
* load the a class through this loader.
*/
......@@ -309,11 +309,11 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* Creates a classloader for the given project using the classpath given.
*
* @param project The project to which this classloader is to belong.
* Must not be <code>null</code>.
* Must not be {@code null}.
* @param classpath The classpath to use to load the classes. May be
* <code>null</code>, in which case no path
* {@code null}, in which case no path
* elements are set up to start with.
* @param parentFirst If <code>true</code>, indicates that the parent
* @param parentFirst If {@code true}, indicates that the parent
* classloader should be consulted before trying to
* load the a class through this loader.
*/
......@@ -327,10 +327,10 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* classes.
*
* @param parent The parent classloader to which unsatisfied loading
* attempts are delegated. May be <code>null</code>,
* attempts are delegated. May be {@code null},
* in which case the classloader which loaded this
* class is used as the parent.
* @param parentFirst If <code>true</code>, indicates that the parent
* @param parentFirst If {@code true}, indicates that the parent
* classloader should be consulted before trying to
* load the a class through this loader.
*/
......@@ -402,7 +402,7 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* Logs a message through the project object if one has been provided.
*
* @param message The message to log.
* Should not be <code>null</code>.
* Should not be {@code null}.
*
* @param priority The logging priority of the message.
*/
......@@ -447,7 +447,7 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* Adds an element to the classpath to be searched.
*
* @param pathElement The path element to add. Must not be
* <code>null</code>.
* {@code null}.
*
* @exception BuildException if the given path element cannot be resolved
* against the project.
......@@ -578,7 +578,7 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* way.
*
* @param theClass The class to initialize.
* Must not be <code>null</code>.
* Must not be {@code null}.
*
* @deprecated since 1.6.x.
* Use Class.forName with initialize=true instead.
......@@ -624,7 +624,7 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* All subpackages are also included.
*
* @param packageRoot The root of all packages to be included.
* Should not be <code>null</code>.
* Should not be {@code null}.
*/
public void addSystemPackageRoot(String packageRoot) {
systemPackages.addElement(packageRoot + (packageRoot.endsWith(".") ? "" : "."));
......@@ -637,7 +637,7 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* All subpackages are also included.
*
* @param packageRoot The root of all packages to be included.
* Should not be <code>null</code>.
* Should not be {@code null}.
*/
public void addLoaderPackageRoot(String packageRoot) {
loaderPackages.addElement(packageRoot + (packageRoot.endsWith(".") ? "" : "."));
......@@ -651,7 +651,7 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* will use this classloader.
*
* @param classname The name of the class to be loaded.
* Must not be <code>null</code>.
* Must not be {@code null}.
*
* @return the required Class object
*
......@@ -678,7 +678,7 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* loader.
*
* @param classname The name of the class to be loaded.
* Must not be <code>null</code>.
* Must not be {@code null}.
*
* @return the required Class object
*
......@@ -700,9 +700,9 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* Returns a stream to read the requested resource name.
*
* @param name The name of the resource for which a stream is required.
* Must not be <code>null</code>.
* Must not be {@code null}.
*
* @return a stream to the required resource or <code>null</code> if the
* @return a stream to the required resource or {@code null} if the
* resource cannot be found on the loader's classpath.
*/
public InputStream getResourceAsStream(String name) {
......@@ -741,9 +741,9 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* Returns a stream to read the requested resource name from this loader.
*
* @param name The name of the resource for which a stream is required.
* Must not be <code>null</code>.
* Must not be {@code null}.
*
* @return a stream to the required resource or <code>null</code> if
* @return a stream to the required resource or {@code null} if
* the resource cannot be found on the loader's classpath.
*/
private InputStream loadResource(String name) {
......@@ -764,9 +764,9 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* classloader).
*
* @param name The name of the system resource to load.
* Must not be <code>null</code>.
* Must not be {@code null}.
*
* @return a stream to the named resource, or <code>null</code> if
* @return a stream to the named resource, or {@code null} if
* the resource cannot be found.
*/
private InputStream loadBaseResource(String name) {
......@@ -778,11 +778,11 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* either be a directory or a zip file.
*
* @param file the file (directory or jar) in which to search for the
* resource. Must not be <code>null</code>.
* resource. Must not be {@code null}.
* @param resourceName The name of the resource for which a stream is
* required. Must not be <code>null</code>.
* required. Must not be {@code null}.
*
* @return a stream to the required resource or <code>null</code> if
* @return a stream to the required resource or {@code null} if
* the resource cannot be found in the given file.
*/
private InputStream getResourceStream(File file, String resourceName) {
......@@ -825,7 +825,7 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
*
* @param resourceName
* The name of the resource to check. Must not be
* <code>null</code>.
* {@code null}.
*
* @return whether or not the parent classloader should be checked for a
* resource before this one is.
......@@ -875,9 +875,9 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* code in a way that is independent of the location of the code.
*
* @param name The name of the resource for which a stream is required.
* Must not be <code>null</code>.
* Must not be {@code null}.
*
* @return a URL for reading the resource, or <code>null</code> if the
* @return a URL for reading the resource, or {@code null} if the
* resource could not be found or the caller doesn't have
* adequate privileges to get the resource.
*/
......@@ -939,7 +939,7 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* given name by searching the class loader's classpath.
*
* @param name The resource name to search for.
* Must not be <code>null</code>.
* Must not be {@code null}.
* @return an enumeration of URLs for the resources
* @exception IOException if I/O errors occurs (can't happen)
*/
......@@ -952,7 +952,7 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* given name by searching the class loader's classpath.
*
* @param name The resource name to search for.
* Must not be <code>null</code>.
* Must not be {@code null}.
* @param parentHasBeenSearched whether ClassLoader.this.parent
* has been searched - will be true if the method is (indirectly)
* called from ClassLoader.getResources
......@@ -992,11 +992,11 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* either be a directory or a zip file.
*
* @param file The file (directory or jar) in which to search for
* the resource. Must not be <code>null</code>.
* the resource. Must not be {@code null}.
* @param resourceName The name of the resource for which a stream
* is required. Must not be <code>null</code>.
* is required. Must not be {@code null}.
*
* @return a stream to the required resource or <code>null</code> if the
* @return a stream to the required resource or {@code null} if the
* resource cannot be found in the given file object.
*/
protected URL getResourceURL(File file, String resourceName) {
......@@ -1051,8 +1051,8 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* ClassNotFoundException.
*
* @param classname The name of the class to be loaded.
* Must not be <code>null</code>.
* @param resolve <code>true</code> if all classes upon which this class
* Must not be {@code null}.
* @param resolve {@code true} if all classes upon which this class
* depends are to be loaded.
*
* @return the required Class object
......@@ -1113,7 +1113,7 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* searching purposes.
*
* @param classname The class name in dot format (eg java.lang.Integer).
* Must not be <code>null</code>.
* Must not be {@code null}.
*
* @return the classname in filesystem format (eg java/lang/Integer.class)
*/
......@@ -1295,9 +1295,9 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* Reads a class definition from a stream.
*
* @param stream The stream from which the class is to be read.
* Must not be <code>null</code>.
* Must not be {@code null}.
* @param classname The name of the class in the stream.
* Must not be <code>null</code>.
* Must not be {@code null}.
* @param container the file or directory containing the class.
*
* @return the Class object read from the stream.
......@@ -1324,7 +1324,7 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* Searches for and load a class on the classpath of this class loader.
*
* @param name The name of the class to be loaded. Must not be
* <code>null</code>.
* {@code null}.
*
* @return the required Class object
*
......@@ -1351,7 +1351,7 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* Finds a class on the given classpath.
*
* @param name The name of the class to be loaded. Must not be
* <code>null</code>.
* {@code null}.
*
* @return the required Class object
*
......@@ -1391,7 +1391,7 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
* no parent classloader has been specified.
*
* @param name The name of the class to be loaded.
* Must not be <code>null</code>.
* Must not be {@code null}.
*
* @return the required Class object
*
......@@ -1536,7 +1536,7 @@ public class AntClassLoader extends ClassLoader implements SubBuildListener {
}
/**
* Returns a <code>String</code> representing this loader.
* Returns a {@code String} representing this loader.
* @return the path that this classloader has.
*/
public String toString() {
......
......@@ -335,8 +335,8 @@ public class SystemProperties {
* Determines the integer value of the system property with the
* specified name, or a default value.
*
* This behaves just like <code>Integer.getInteger(String,Integer)</code>, except that it
* also consults the <code>ServletContext</code>'s "init" parameters. If neither exist,
* This behaves just like {@code Integer.getInteger(String,Integer)}, except that it
* also consults the {@code ServletContext}'s "init" parameters. If neither exist,
* return the default value.
*
* @param name property name.
......@@ -353,8 +353,8 @@ public class SystemProperties {
* Determines the integer value of the system property with the
* specified name, or a default value.
*
* This behaves just like <code>Integer.getInteger(String,Integer)</code>, except that it
* also consults the <code>ServletContext</code>'s "init" parameters. If neither exist,
* This behaves just like {@code Integer.getInteger(String,Integer)}, except that it
* also consults the {@code ServletContext}'s "init" parameters. If neither exist,
* return the default value.
*
* @param name property name.
......@@ -399,8 +399,8 @@ public class SystemProperties {
* Determines the integer value of the system property with the
* specified name, or a default value.
*
* This behaves just like <code>Long.getLong(String,Long)</code>, except that it
* also consults the <code>ServletContext</code>'s "init" parameters. If neither exist,
* This behaves just like {@code Long.getLong(String,Long)}, except that it
* also consults the {@code ServletContext}'s "init" parameters. If neither exist,
* return the default value.
*
* @param name property name.
......@@ -417,8 +417,8 @@ public class SystemProperties {
* Determines the integer value of the system property with the
* specified name, or a default value.
*
* This behaves just like <code>Long.getLong(String,Long)</code>, except that it
* also consults the <code>ServletContext</code>'s "init" parameters. If neither exist,
* This behaves just like {@code Long.getLong(String,Long)}, except that it
* also consults the {@code ServletContext}'s "init" parameters. If neither exist,
* return the default value.
*
* @param name property name.
......
......@@ -41,7 +41,7 @@ import javax.annotation.Nullable;
/**
* Represents a stream over the lines of a text file.
* <p>
* Although <code>LinesStream</code> implements {@link java.lang.Iterable}, it
* Although {@code LinesStream} implements {@link java.lang.Iterable}, it
* is intended to be first used to initialize a resource in a try-with-resources
* statement and then iterated, as in:
* <pre>
......@@ -53,10 +53,10 @@ import javax.annotation.Nullable;
* </pre>
* This pattern ensures that the underlying file handle is closed properly.
* <p>
* Like {@link java.nio.file.DirectoryStream}, <code>LinesStream</code> supports
* creating at most one <code>Iterator</code>. Invoking {@link #iterator()} to
* obtain a second or subsequent <code>Iterator</code> throws
* <code>IllegalStateException</code>.
* Like {@link java.nio.file.DirectoryStream}, {@code LinesStream} supports
* creating at most one {@code Iterator}. Invoking {@link #iterator()} to
* obtain a second or subsequent {@code Iterator} throws
* {@code IllegalStateException}.
*
* @since 2.111
*/
......@@ -67,10 +67,10 @@ public class LinesStream implements Closeable, Iterable<String> {
private transient @Nullable Iterator<String> iterator;
/**
* Opens the text file at <code>path</code> for reading using charset
* Opens the text file at {@code path} for reading using charset
* {@link java.nio.charset.StandardCharsets#UTF_8}.
* @param path Path to the file to open for reading.
* @throws IOException if the file at <code>path</code> cannot be opened for
* @throws IOException if the file at {@code path} cannot be opened for
* reading.
*/
public LinesStream(@Nonnull Path path) throws IOException {
......
......@@ -68,7 +68,7 @@ public class JavaUtils {
* Returns the JVM's current version as a {@link String}.
* See https://openjdk.java.net/jeps/223 for the expected format.
* <ul>
* <li>Until Java 8 included, the expected format should be starting with <code>1.x</code></li>
* <li>Until Java 8 included, the expected format should be starting with {@code 1.x}</li>
* <li>Starting with Java 9, cf. JEP-223 linked above, the version got simplified in 9.x, 10.x, etc.</li>
* </ul>
*
......
......@@ -49,10 +49,10 @@ public final class XMLUtils {
/**
* Transform the source to the output in a manner that is protected against XXE attacks.
* If the transform can not be completed safely then an IOException is thrown.
* Note - to turn off safety set the system property <code>disableXXEPrevention</code> to <code>true</code>.
* @param source The XML input to transform. - This should be a <code>StreamSource</code> or a
* <code>SAXSource</code> in order to be able to prevent XXE attacks.
* @param out The Result of transforming the <code>source</code>.
* Note - to turn off safety set the system property {@code disableXXEPrevention} to {@code true}.
* @param source The XML input to transform. - This should be a {@code StreamSource} or a
* {@code SAXSource} in order to be able to prevent XXE attacks.
* @param out The Result of transforming the {@code source}.
*/
public static void safeTransform(@Nonnull Source source, @Nonnull Result out) throws TransformerException,
SAXException {
......@@ -196,7 +196,7 @@ public final class XMLUtils {
/**
* potentially unsafe XML transformation.
* @param source The XML input to transform.
* @param out The Result of transforming the <code>source</code>.
* @param out The Result of transforming the {@code source}.
*/
private static void _transform(Source source, Result out) throws TransformerException {
TransformerFactory factory = TransformerFactory.newInstance();
......
......@@ -44,7 +44,7 @@ public class DetachedPluginsUtilTest {
}
/**
* Checks the format of the <code>/jenkins/split-plugins.txt</code> file has maximum 4 columns.
* Checks the format of the {@code /jenkins/split-plugins.txt} file has maximum 4 columns.
*/
@Test
public void checkSplitPluginsFileFormat() throws IOException {
......
......@@ -77,7 +77,7 @@ public class ApiTest {
}
/**
* Test that calling the XML API with the XPath <code>document</code> function fails.
* Test that calling the XML API with the XPath {@code document} function fails.
*
* @throws Exception if so
*/
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册