Skip to content

Commit

Permalink
Replace <tt> by <code> tags in javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
laeubi committed Jan 12, 2024
1 parent 3920637 commit 1fddbfa
Show file tree
Hide file tree
Showing 20 changed files with 73 additions and 73 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ public interface IFuture<ResultType> {
/**
* Cancel the operation
*
* @return <tt>false</tt> if the operation could not be canceled, typically
* because it has already completed normally; <tt>true</tt> otherwise
* @return <code>false</code> if the operation could not be canceled, typically
* because it has already completed normally; <code>true</code> otherwise
*/
public boolean cancel();

Expand Down Expand Up @@ -119,7 +119,7 @@ public interface IFuture<ResultType> {

/**
* <p>
* Returns <tt>true</tt> if <b>any</b> underlying operation(s) have completed.
* Returns <code>true</code> if <b>any</b> underlying operation(s) have completed.
* </p>
* <p>
* If this future represents access to just one operation, then this method and
Expand All @@ -133,14 +133,14 @@ public interface IFuture<ResultType> {
* first operation is completed, it will return <code>false</code>.
* </p>
*
* @return <tt>true</tt> if any operations represented by this future have
* @return <code>true</code> if any operations represented by this future have
* completed.
*/
boolean hasValue();

/**
* <p>
* Returns <tt>true</tt> if <b>all</b> underlying operation(s) have been
* Returns <code>true</code> if <b>all</b> underlying operation(s) have been
* completed.
* </p>
* <p>
Expand All @@ -156,11 +156,11 @@ public interface IFuture<ResultType> {
* </p>
* <p>
* Completion can be due to normal operation completion, an exception, or user
* cancellation -- in all of these cases, this method will return <tt>true</tt>
* cancellation -- in all of these cases, this method will return <code>true</code>
* if all underlying operation(s) have been completed.
* </p>
*
* @return <tt>true</tt> if all operation(s) have completed in some manner.
* @return <code>true</code> if all operation(s) have completed in some manner.
*/
boolean isDone();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ public void stop(BundleContext contxt) throws Exception {
*
* @param reference Reference to service being added to the ServiceTracker.
* @return The service object to be tracked for the ServiceReference or
* <tt>null</tt> if the ServiceReference should not be tracked.
* <code>null</code> if the ServiceReference should not be tracked.
*/
public Object addingService(ServiceReference reference) {
if (Activator.DEBUG) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ public void close() {
*
* @param reference Reference to service being added to the ServiceTracker.
* @return The service object to be tracked for the ServiceReference or
* <tt>null</tt> if the ServiceReference should not be tracked.
* <code>null</code> if the ServiceReference should not be tracked.
*/
public Object addingService(ServiceReference reference) {
if (Activator.DEBUG) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ public DriverLocatorTracker(Activator manager) {
*
* @param reference Reference to service being added to the ServiceTracker.
* @return The service object to be tracked for the ServiceReference or
* <tt>null</tt> if the ServiceReference should not be tracked.
* <code>null</code> if the ServiceReference should not be tracked.
*/
public Object addingService(ServiceReference reference) {
if (Activator.DEBUG) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ public DriverTracker(Activator manager) {
*
* @param reference Reference to service being added to the ServiceTracker.
* @return The service object to be tracked for the ServiceReference or
* <tt>null</tt> if the ServiceReference should not be tracked.
* <code>null</code> if the ServiceReference should not be tracked.
*/
public Object addingService(ServiceReference reference) {
if (Activator.DEBUG) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
*
* Implementation notes:
*
* - For thread safety, we always synchronize on <tt>writeLock</tt> when writing
* - For thread safety, we always synchronize on <code>writeLock</code> when writing
* the children or properties fields. Must ensure we don't synchronize when
* calling client code such as listeners.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,8 @@ protected Group(String name, UserAdmin useradmin) {
* name matches that of the specified role.
*
* @throws SecurityException If a security manager exists and the caller does
* not have the <tt>UserAdminPermission</tt> with name
* <tt>admin</tt>.
* not have the <code>UserAdminPermission</code> with name
* <code>admin</code>.
*/
@Override
public boolean addMember(org.osgi.service.useradmin.Role role) {
Expand Down Expand Up @@ -146,8 +146,8 @@ protected boolean addMember(org.osgi.service.useradmin.Role role, boolean store)
* whose name matches that of the specified role.
*
* @throws SecurityException If a security manager exists and the caller does
* not have the <tt>UserAdminPermission</tt> with name
* <tt>admin</tt>.
* not have the <code>UserAdminPermission</code> with name
* <code>admin</code>.
*/
@Override
public boolean addRequiredMember(org.osgi.service.useradmin.Role role) {
Expand Down Expand Up @@ -186,8 +186,8 @@ protected boolean addRequiredMember(org.osgi.service.useradmin.Role role, boolea
* <code>false</code>.
*
* @throws SecurityException If a security manager exists and the caller does
* not have the <tt>UserAdminPermission</tt> with name
* <tt>admin</tt>.
* not have the <code>UserAdminPermission</code> with name
* <code>admin</code>.
*/
@Override
public boolean removeMember(org.osgi.service.useradmin.Role role) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@
* propagated to the {@link UserAdmin} service and made persistent.
* <p>
* Every UserAdmin contains a set of predefined roles that are always present
* and cannot be removed. All predefined roles are of type <tt>ROLE</tt>. This
* version of the <tt>org.osgi.service.useradmin</tt> package defines a single
* and cannot be removed. All predefined roles are of type <code>ROLE</code>. This
* version of the <code>org.osgi.service.useradmin</code> package defines a single
* predefined role named &quot;user.anyone&quot;, which is inherited by any
* other role. Other predefined roles may be added in the future.
*/
Expand Down Expand Up @@ -86,10 +86,10 @@ public int getType() {
* cause a UserAdminEvent of type {@link UserAdminEvent#ROLE_CHANGED} to be
* broadcast to any UserAdminListeners.
* <p>
* Only objects of type <tt>String</tt> may be used as property keys, and only
* objects of type <tt>String</tt> or <tt>byte[]</tt> may be used as property
* Only objects of type <code>String</code> may be used as property keys, and only
* objects of type <code>String</code> or <code>byte[]</code> may be used as property
* values. Any other types will cause an exception of type
* <tt>IllegalArgumentException</tt> to be raised.
* <code>IllegalArgumentException</code> to be raised.
* <p>
* In order to add, change, or remove a property in the returned Dictionary, a
* {@link UserAdminPermission} named after the property name (or a prefix of it)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,9 @@ public Dictionary<String, Object> getCredentials() {
* Checks to see if this User has a credential with the specified key set to the
* specified value.
* <p>
* If the specified credential value is not of type <tt>String</tt> or
* <tt>byte[]</tt>, it is ignored, that is, <tt>false</tt> is returned (as
* opposed to an <tt>IllegalArgumentException</tt> being raised).
* If the specified credential value is not of type <code>String</code> or
* <code>byte[]</code>, it is ignored, that is, <code>false</code> is returned (as
* opposed to an <code>IllegalArgumentException</code> being raised).
*
* @param key The credential key.
* @param value The credential value.
Expand All @@ -90,7 +90,7 @@ public Dictionary<String, Object> getCredentials() {
* <code>false</code> otherwise.
*
* @throws SecurityException If a security manager exists and the caller does
* not have the <tt>UserAdminPermission</tt> named
* not have the <code>UserAdminPermission</code> named
* after the credential key (or a prefix of it) with
* action <code>getCredential</code>.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,12 +95,12 @@ protected void setServiceReference(ServiceReference reference) {
* @return The newly created role, or <code>null</code> if a role with the given
* name already exists.
*
* @throws IllegalArgumentException if <tt>type</tt> is invalid.
* @throws IllegalArgumentException if <code>type</code> is invalid.
*
* @throws SecurityException If a security manager exists and the caller
* does not have the
* <tt>UserAdminPermission</tt> with name
* <tt>admin</tt>.
* <code>UserAdminPermission</code> with name
* <code>admin</code>.
*/
@Override
public org.osgi.service.useradmin.Role createRole(String name, int type) {
Expand Down Expand Up @@ -164,8 +164,8 @@ protected org.osgi.service.useradmin.Role createRole(String name, int type, bool
* UserAdmin and could be removed, otherwise <code>false</code>.
*
* @throws SecurityException If a security manager exists and the caller does
* not have the <tt>UserAdminPermission</tt> with name
* <tt>admin</tt>.
* not have the <code>UserAdminPermission</code> with name
* <code>admin</code>.
*/
@Override
public boolean removeRole(String name) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,20 +72,20 @@ protected void generateEvent(int type, Role role) {
}

/**
* A service is being added to the <tt>ServiceTracker</tt> object.
* A service is being added to the <code>ServiceTracker</code> object.
*
* <p>
* This method is called before a service which matched the search parameters of
* the <tt>ServiceTracker</tt> object is added to it. This method should return
* the service object to be tracked for this <tt>ServiceReference</tt> object.
* The returned service object is stored in the <tt>ServiceTracker</tt> object
* and is available from the <tt>getService</tt> and <tt>getServices</tt>
* the <code>ServiceTracker</code> object is added to it. This method should return
* the service object to be tracked for this <code>ServiceReference</code> object.
* The returned service object is stored in the <code>ServiceTracker</code> object
* and is available from the <code>getService</code> and <code>getServices</code>
* methods.
*
* @param reference Reference to service being added to the
* <tt>ServiceTracker</tt> object.
* @return The service object to be tracked for the <tt>ServiceReference</tt>
* object or <tt>null</tt> if the <tt>ServiceReference</tt> object
* <code>ServiceTracker</code> object.
* @return The service object to be tracked for the <code>ServiceReference</code>
* object or <code>null</code> if the <code>ServiceReference</code> object
* should not be tracked.
*/
@Override
Expand All @@ -98,11 +98,11 @@ public Object addingService(ServiceReference reference) {
}

/**
* A service tracked by the <tt>ServiceTracker</tt> object has been removed.
* A service tracked by the <code>ServiceTracker</code> object has been removed.
*
* <p>
* This method is called after a service is no longer being tracked by the
* <tt>ServiceTracker</tt> object.
* <code>ServiceTracker</code> object.
*
* @param reference Reference to service that has been removed.
* @param service The service object for the removed service.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ public abstract class StateImpl implements State {
* syntax version 2 will not recognize this header.
*
* <p>The attribute value may be retrieved from the
* <tt>Dictionary</tt> object returned by the <tt>Bundle.getHeaders</tt> method.
* <code>Dictionary</code> object returned by the <code>Bundle.getHeaders</code> method.
* @deprecated
*/
@Deprecated
Expand All @@ -102,7 +102,7 @@ public abstract class StateImpl implements State {
* for Require-Bundle
* identifying that any packages that are provided
* by the required bundle must be reprovided by the requiring bundle.
* The default value is <tt>false</tt>.
* The default value is <code>false</code>.
* <p>
* The attribute value is encoded in the Require-Bundle manifest
* header like:
Expand All @@ -123,7 +123,7 @@ public abstract class StateImpl implements State {
* identifying that a required bundle is optional and that
* the requiring bundle can be resolved if there is no
* suitable required bundle.
* The default value is <tt>false</tt>.
* The default value is <code>false</code>.
*
* <p>The attribute value is encoded in the Require-Bundle manifest
* header like:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ public synchronized int size() {

/**
* Tests if this dictionary maps no keys to value. The general contract
* for the <tt>isEmpty</tt> method is that the result is true if and only
* for the <code>isEmpty</code> method is that the result is true if and only
* if this dictionary contains no entries.
*
* @return <code>true</code> if this dictionary maps no keys to values;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -519,46 +519,46 @@ public ServiceRegistration<?> registerService(String clazz, Object service, Dict
}

/**
* Returns a list of <tt>ServiceReference</tt> objects. This method returns a list of
* <tt>ServiceReference</tt> objects for services which implement and were registered under
* Returns a list of <code>ServiceReference</code> objects. This method returns a list of
* <code>ServiceReference</code> objects for services which implement and were registered under
* the specified class and match the specified filter criteria.
*
* <p>The list is valid at the time of the call to this method, however as the Framework is
* a very dynamic environment, services can be modified or unregistered at anytime.
*
* <p><tt>filter</tt> is used to select the registered service whose
* <p><code>filter</code> is used to select the registered service whose
* properties objects contain keys and values which satisfy the filter.
* See {@link Filter}for a description of the filter string syntax.
*
* <p>If <tt>filter</tt> is <tt>null</tt>, all registered services
* <p>If <code>filter</code> is <code>null</code>, all registered services
* are considered to match the filter.
* <p>If <tt>filter</tt> cannot be parsed, an {@link InvalidSyntaxException} will
* <p>If <code>filter</code> cannot be parsed, an {@link InvalidSyntaxException} will
* be thrown with a human readable message where the filter became unparsable.
*
* <p>The following steps are required to select a service:
* <ol>
* <li>If the Java Runtime Environment supports permissions, the caller is checked for the
* <tt>ServicePermission</tt> to get the service with the specified class.
* If the caller does not have the correct permission, <tt>null</tt> is returned.
* <li>If the filter string is not <tt>null</tt>, the filter string is
* <code>ServicePermission</code> to get the service with the specified class.
* If the caller does not have the correct permission, <code>null</code> is returned.
* <li>If the filter string is not <code>null</code>, the filter string is
* parsed and the set of registered services which satisfy the filter is
* produced.
* If the filter string is <tt>null</tt>, then all registered services
* If the filter string is <code>null</code>, then all registered services
* are considered to satisfy the filter.
* <li>If <code>clazz</code> is not <tt>null</tt>, the set is further reduced to
* those services which are an <tt>instanceof</tt> and were registered under the specified class.
* <li>If <code>clazz</code> is not <code>null</code>, the set is further reduced to
* those services which are an <code>instanceof</code> and were registered under the specified class.
* The complete list of classes of which a service is an instance and which
* were specified when the service was registered is available from the
* service's {@link Constants#OBJECTCLASS}property.
* <li>An array of <tt>ServiceReference</tt> to the selected services is returned.
* <li>An array of <code>ServiceReference</code> to the selected services is returned.
* </ol>
*
* @param clazz The class name with which the service was registered, or
* <tt>null</tt> for all services.
* <code>null</code> for all services.
* @param filter The filter criteria.
* @return An array of <tt>ServiceReference</tt> objects, or
* <tt>null</tt> if no services are registered which satisfy the search.
* @exception InvalidSyntaxException If <tt>filter</tt> contains
* @return An array of <code>ServiceReference</code> objects, or
* <code>null</code> if no services are registered which satisfy the search.
* @exception InvalidSyntaxException If <code>filter</code> contains
* an invalid filter string which cannot be parsed.
*/
@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ void register(Dictionary<String, ?> props) {
* @exception java.lang.IllegalStateException If
* this ServiceRegistration has already been unregistered.
*
* @exception IllegalArgumentException If the <tt>properties</tt>
* @exception IllegalArgumentException If the <code>properties</code>
* parameter contains case variants of the same key name.
*/
@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
import java.util.Dictionary;

/**
* A plug-in convertor is able to convert plug-in manifest files (<tt>plugin.xml</tt>) and
* fragment manifest files (<tt>fragment.xml</tt>) to bundle manifest files (<tt>MANIFEST.MF</tt>).
* A plug-in convertor is able to convert plug-in manifest files (<code>plugin.xml</code>) and
* fragment manifest files (<code>fragment.xml</code>) to bundle manifest files (<code>MANIFEST.MF</code>).
* <p>
* This interface is not intended to be implemented by clients.
* </p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public class PermissionData {
* exists in persistent storage.
*
* @return The locations that have permission data in
* persistent storage, or <tt>null</tt> if there is no permission data
* persistent storage, or <code>null</code> if there is no permission data
* in persistent storage.
*/
public String[] getLocations() {
Expand All @@ -56,10 +56,10 @@ public String[] getLocations() {
*
* @param location The location whose permission data is to
* be returned.
* The location can be <tt>null</tt> for the default permission data.
* The location can be <code>null</code> for the default permission data.
*
* @return The permission data assigned to the specified
* location, or <tt>null</tt> if that location has not been assigned any
* location, or <code>null</code> if that location has not been assigned any
* permission data.
*/
public String[] getPermissionData(String location) {
Expand All @@ -78,8 +78,8 @@ public String[] getPermissionData(String location) {
*
* @param location The location that will be assigned the
* permissions.
* The location can be <tt>null</tt> for the default permission data.
* @param data The permission data to be assigned, or <tt>null</tt>
* The location can be <code>null</code> for the default permission data.
* @param data The permission data to be assigned, or <code>null</code>
* if the specified location is to be removed from persistent storaqe.
*/
public void setPermissionData(String location, String[] data) {
Expand Down
Loading

0 comments on commit 1fddbfa

Please sign in to comment.