diff --git a/oak-api/src/main/java/org/apache/jackrabbit/oak/api/PropertyState.java b/oak-api/src/main/java/org/apache/jackrabbit/oak/api/PropertyState.java index 1ca0305ada..90f0cdbcbd 100644 --- a/oak-api/src/main/java/org/apache/jackrabbit/oak/api/PropertyState.java +++ b/oak-api/src/main/java/org/apache/jackrabbit/oak/api/PropertyState.java @@ -60,7 +60,7 @@ public interface PropertyState { * If the target type is not the same as the type of this property an attempt * is made to convert the value to the target type. If the conversion fails an * exception is thrown. The actual conversions which take place are those defined - * in the {@link org.apache.jackrabbit.oak.plugins.value.Conversions} class. + * in the {@code org.apache.jackrabbit.oak.plugins.value.Conversions} class. * @param type target type * @param * @return the value of this property @@ -81,7 +81,7 @@ public interface PropertyState { * If the target type is not the same as the type of this property an attempt * is made to convert the value to the target type. If the conversion fails an * exception is thrown. The actual conversions which take place are those defined - * in the {@link org.apache.jackrabbit.oak.plugins.value.Conversions} class. + * in the {@code org.apache.jackrabbit.oak.plugins.value.Conversions} class. * @param type target type * @param index * @param diff --git a/oak-api/src/main/java/org/apache/jackrabbit/oak/api/jmx/CacheStatsMBean.java b/oak-api/src/main/java/org/apache/jackrabbit/oak/api/jmx/CacheStatsMBean.java index db3dd05b90..0b26127960 100644 --- a/oak-api/src/main/java/org/apache/jackrabbit/oak/api/jmx/CacheStatsMBean.java +++ b/oak-api/src/main/java/org/apache/jackrabbit/oak/api/jmx/CacheStatsMBean.java @@ -25,13 +25,13 @@ public interface CacheStatsMBean { String getName(); /** - * Returns the number of times {@link com.google.common.cache.Cache} lookup methods have returned either a cached or + * Returns the number of times {@code com.google.common.cache.Cache} lookup methods have returned either a cached or * uncached value. This is defined as {@code getHitCount + getMissCount}. */ long getRequestCount(); /** - * Returns the number of times {@link com.google.common.cache.Cache} lookup methods have returned a cached value. + * Returns the number of times {@code com.google.common.cache.Cache} lookup methods have returned a cached value. */ long getHitCount(); @@ -42,8 +42,8 @@ public interface CacheStatsMBean { */ double getHitRate(); /** - * Returns the number of times {@link com.google.common.cache.Cache} lookup methods have returned an uncached (newly - * loaded) value, or null. Multiple concurrent calls to {@link com.google.common.cache.Cache} lookup methods on an absent + * Returns the number of times {@code com.google.common.cache.Cache} lookup methods have returned an uncached (newly + * loaded) value, or null. Multiple concurrent calls to {@code com.google.common.cache.Cache} lookup methods on an absent * value can result in multiple misses, all returning the results of a single cache load * operation. */ @@ -61,14 +61,14 @@ public interface CacheStatsMBean { double getMissRate(); /** - * Returns the total number of times that {@link com.google.common.cache.Cache} lookup methods attempted to load new + * Returns the total number of times that {@code com.google.common.cache.Cache} lookup methods attempted to load new * values. This includes both successful load operations, as well as those that threw * exceptions. This is defined as {@code getLoadSuccessCount + getLoadExceptionCount}. */ long getLoadCount(); /** - * Returns the number of times {@link com.google.common.cache.Cache} lookup methods have successfully loaded a new value. + * Returns the number of times {@code com.google.common.cache.Cache} lookup methods have successfully loaded a new value. * This is always incremented in conjunction with {@link #getMissCount}, though {@code getMissCount} * is also incremented when an exception is encountered during cache loading (see * {@link #getLoadExceptionCount}). Multiple concurrent misses for the same key will result in a @@ -77,7 +77,7 @@ public interface CacheStatsMBean { long getLoadSuccessCount(); /** - * Returns the number of times {@link com.google.common.cache.Cache} lookup methods threw an exception while loading a + * Returns the number of times {@code com.google.common.cache.Cache} lookup methods threw an exception while loading a * new value. This is always incremented in conjunction with {@code getMissCount}, though * {@code getMissCount} is also incremented when cache loading completes successfully (see * {@link #getLoadSuccessCount}). Multiple concurrent misses for the same key will result in a @@ -107,7 +107,7 @@ public interface CacheStatsMBean { /** * Returns the number of times an entry has been evicted. This count does not include manual - * {@linkplain com.google.common.cache.Cache#invalidate invalidations}. + * {@code com.google.common.cache.Cache#invalidate invalidations}. */ long getEvictionCount(); diff --git a/oak-api/src/main/java/org/apache/jackrabbit/oak/api/jmx/CheckpointMBean.java b/oak-api/src/main/java/org/apache/jackrabbit/oak/api/jmx/CheckpointMBean.java index 729d6460eb..f598469c83 100644 --- a/oak-api/src/main/java/org/apache/jackrabbit/oak/api/jmx/CheckpointMBean.java +++ b/oak-api/src/main/java/org/apache/jackrabbit/oak/api/jmx/CheckpointMBean.java @@ -24,7 +24,7 @@ import javax.management.openmbean.TabularData; import aQute.bnd.annotation.ProviderType; /** - * MBean for managing {@link org.apache.jackrabbit.oak.spi.state.NodeStore#checkpoint checkpoints}. + * MBean for managing {@code org.apache.jackrabbit.oak.spi.state.NodeStore#checkpoint checkpoints}. */ @ProviderType public interface CheckpointMBean { @@ -39,17 +39,17 @@ public interface CheckpointMBean { /** * Create a new checkpoint with the given {@code lifetime}. + * See {@code org.apache.jackrabbit.oak.spi.state.NodeStore#checkpoint} * @param lifetime * @return the id of the newly created checkpoint - * @see org.apache.jackrabbit.oak.spi.state.NodeStore#checkpoint */ String createCheckpoint(long lifetime); /** * Release the checkpoint with the given {@code id}. + * See {@code org.apache.jackrabbit.oak.spi.state.NodeStore#checkpoint} * @param id * @return {@code true} on success, {@code false} otherwise. - * @see org.apache.jackrabbit.oak.spi.state.NodeStore#checkpoint */ boolean releaseCheckpoint(String id); } diff --git a/oak-api/src/main/java/org/apache/jackrabbit/oak/api/jmx/IndexStatsMBean.java b/oak-api/src/main/java/org/apache/jackrabbit/oak/api/jmx/IndexStatsMBean.java index 6c698c8603..2889dd1422 100644 --- a/oak-api/src/main/java/org/apache/jackrabbit/oak/api/jmx/IndexStatsMBean.java +++ b/oak-api/src/main/java/org/apache/jackrabbit/oak/api/jmx/IndexStatsMBean.java @@ -143,14 +143,14 @@ public interface IndexStatsMBean { String getTemporaryCheckpoints(); /** - * Returns the number of executions as a {@link org.apache.jackrabbit.api.stats.TimeSeries}. + * Returns the number of executions as a {@code org.apache.jackrabbit.api.stats.TimeSeries}. * * @return the execution count time series */ CompositeData getExecutionCount(); /** - * Returns the execution time as a {@link org.apache.jackrabbit.api.stats.TimeSeries}. + * Returns the execution time as a {@code org.apache.jackrabbit.api.stats.TimeSeries}. * * @return the execution times time series */ @@ -158,7 +158,7 @@ public interface IndexStatsMBean { CompositeData getExecutionTime(); /** - * Returns the number of indexed nodes as a {@link org.apache.jackrabbit.api.stats.TimeSeries}. + * Returns the number of indexed nodes as a {@code org.apache.jackrabbit.api.stats.TimeSeries}. * * @return the indexed nodes time series */ diff --git a/oak-api/src/main/java/org/apache/jackrabbit/oak/api/jmx/RepositoryStatsMBean.java b/oak-api/src/main/java/org/apache/jackrabbit/oak/api/jmx/RepositoryStatsMBean.java index 9ec7b58759..a309c9787f 100644 --- a/oak-api/src/main/java/org/apache/jackrabbit/oak/api/jmx/RepositoryStatsMBean.java +++ b/oak-api/src/main/java/org/apache/jackrabbit/oak/api/jmx/RepositoryStatsMBean.java @@ -26,7 +26,7 @@ import aQute.bnd.annotation.ProviderType; /** * MBean for providing repository wide statistics. * This MBean exposes the time series provided by - * {@link org.apache.jackrabbit.api.stats.RepositoryStatistics RepositoryStatistics} + * {@code org.apache.jackrabbit.api.stats.RepositoryStatistics RepositoryStatistics} * through JMX as {@code CompositeData} of arrays. */ @ProviderType @@ -34,72 +34,72 @@ public interface RepositoryStatsMBean { String TYPE = "RepositoryStats"; /** - * @see org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_COUNT + * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_COUNT} */ CompositeData getSessionCount(); /** - * @see org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_LOGIN_COUNTER + * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_LOGIN_COUNTER} */ CompositeData getSessionLogin(); /** - * @see org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_READ_COUNTER + * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_READ_COUNTER} */ CompositeData getSessionReadCount(); /** - * @see org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_READ_DURATION + * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_READ_DURATION} */ CompositeData getSessionReadDuration(); /** - * @see org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_READ_AVERAGE + * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_READ_AVERAGE} */ CompositeData getSessionReadAverage(); /** - * @see org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_WRITE_COUNTER + * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_WRITE_COUNTER} */ CompositeData getSessionWriteCount(); /** - * @see org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_READ_DURATION + * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_READ_DURATION} */ CompositeData getSessionWriteDuration(); /** - * @see org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_WRITE_AVERAGE + * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_WRITE_AVERAGE} */ CompositeData getSessionWriteAverage(); /** - * @see org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#QUERY_COUNT + * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#QUERY_COUNT} */ CompositeData getQueryCount(); /** - * @see org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#QUERY_DURATION + * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#QUERY_DURATION} */ CompositeData getQueryDuration(); /** - * @see org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#QUERY_AVERAGE + * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#QUERY_AVERAGE} */ CompositeData getQueryAverage(); /** - * @see org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#OBSERVATION_EVENT_COUNTER + * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#OBSERVATION_EVENT_COUNTER} */ CompositeData getObservationEventCount(); /** - * @see org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#OBSERVATION_EVENT_DURATION + * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#OBSERVATION_EVENT_DURATION} */ CompositeData getObservationEventDuration(); /** - * @see org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#OBSERVATION_EVENT_AVERAGE + * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#OBSERVATION_EVENT_AVERAGE} */ CompositeData getObservationEventAverage();