forked from plusone/plusone-commons
修改 Javadoc。
parent
3455dd1f32
commit
87c9d15751
|
@ -26,7 +26,7 @@ import java.lang.annotation.Target;
|
||||||
*
|
*
|
||||||
* <p>标识方法为静态工厂方法
|
* <p>标识方法为静态工厂方法
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
* @since 0.1.0
|
* @since 0.1.0
|
||||||
*/
|
*/
|
||||||
@Target(ElementType.METHOD)
|
@Target(ElementType.METHOD)
|
||||||
|
|
|
@ -25,7 +25,7 @@ import java.lang.annotation.Target;
|
||||||
/**
|
/**
|
||||||
* ValueObject - 值对象
|
* ValueObject - 值对象
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
* @since 0.1.0
|
* @since 0.1.0
|
||||||
*/
|
*/
|
||||||
@Inherited
|
@Inherited
|
||||||
|
|
|
@ -25,7 +25,7 @@ import java.lang.annotation.Target;
|
||||||
* 标识该方法是可虚方法。
|
* 标识该方法是可虚方法。
|
||||||
* <p>该注解用于提醒、强调父类虽然有默认实现,但子类可以根据自己的需要覆写。</p>
|
* <p>该注解用于提醒、强调父类虽然有默认实现,但子类可以根据自己的需要覆写。</p>
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
* @since 0.1.0
|
* @since 0.1.0
|
||||||
*/
|
*/
|
||||||
@Target(ElementType.METHOD)
|
@Target(ElementType.METHOD)
|
||||||
|
|
|
@ -25,7 +25,7 @@ import javax.annotation.Nonnull;
|
||||||
* 用于像自定义异常等需要带有 {@code code} 字段的类,
|
* 用于像自定义异常等需要带有 {@code code} 字段的类,
|
||||||
* 方便其它地方的程序判断该类的是否实现了此接口,以此获取其实例的 {@code code} 字段的值。
|
* 方便其它地方的程序判断该类的是否实现了此接口,以此获取其实例的 {@code code} 字段的值。
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
*/
|
*/
|
||||||
public interface IWithCode<T> {
|
public interface IWithCode<T> {
|
||||||
@Nonnull
|
@Nonnull
|
||||||
|
|
|
@ -21,7 +21,7 @@ package xyz.zhouxy.plusone.commons.base;
|
||||||
* 用于像自定义异常等需要带有 {@code code} 字段的类,
|
* 用于像自定义异常等需要带有 {@code code} 字段的类,
|
||||||
* 方便其它地方的程序判断该类的是否实现了此接口,以此获取其实例的 {@code code} 字段的值。
|
* 方便其它地方的程序判断该类的是否实现了此接口,以此获取其实例的 {@code code} 字段的值。
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
*/
|
*/
|
||||||
public interface IWithIntCode {
|
public interface IWithIntCode {
|
||||||
int getCode();
|
int getCode();
|
||||||
|
|
|
@ -21,7 +21,7 @@ package xyz.zhouxy.plusone.commons.base;
|
||||||
* 用于像自定义异常等需要带有 {@code code} 字段的类,
|
* 用于像自定义异常等需要带有 {@code code} 字段的类,
|
||||||
* 方便其它地方的程序判断该类的是否实现了此接口,以此获取其实例的 {@code code} 字段的值。
|
* 方便其它地方的程序判断该类的是否实现了此接口,以此获取其实例的 {@code code} 字段的值。
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
*/
|
*/
|
||||||
public interface IWithLongCode {
|
public interface IWithLongCode {
|
||||||
long getCode();
|
long getCode();
|
||||||
|
|
|
@ -30,7 +30,7 @@ import java.util.concurrent.locks.ReentrantReadWriteLock;
|
||||||
* <b>NOTE: 如果 {@link Table} 不需要更改,请使用 {@link ImmutableTable}</b>
|
* <b>NOTE: 如果 {@link Table} 不需要更改,请使用 {@link ImmutableTable}</b>
|
||||||
* </p>
|
* </p>
|
||||||
*
|
*
|
||||||
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108/">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
* @see Table
|
* @see Table
|
||||||
* @see ImmutableTable
|
* @see ImmutableTable
|
||||||
* @see ReentrantReadWriteLock
|
* @see ReentrantReadWriteLock
|
||||||
|
|
|
@ -21,7 +21,7 @@ import java.util.regex.Pattern;
|
||||||
/**
|
/**
|
||||||
* 正则表达式常量
|
* 正则表达式常量
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
*/
|
*/
|
||||||
public final class PatternConsts {
|
public final class PatternConsts {
|
||||||
|
|
||||||
|
|
|
@ -19,7 +19,7 @@ package xyz.zhouxy.plusone.commons.constant;
|
||||||
/**
|
/**
|
||||||
* 正则表达式常量
|
* 正则表达式常量
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
*/
|
*/
|
||||||
public final class RegexConsts {
|
public final class RegexConsts {
|
||||||
|
|
||||||
|
|
|
@ -28,7 +28,7 @@ import xyz.zhouxy.plusone.commons.util.RegexTools;
|
||||||
/**
|
/**
|
||||||
* 带校验的字符串值对象
|
* 带校验的字符串值对象
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
* @since 0.1.0
|
* @since 0.1.0
|
||||||
*/
|
*/
|
||||||
public abstract class ValidatableStringRecord
|
public abstract class ValidatableStringRecord
|
||||||
|
|
|
@ -24,7 +24,7 @@ import java.util.Objects;
|
||||||
/**
|
/**
|
||||||
* 带错误码的异常。
|
* 带错误码的异常。
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
*/
|
*/
|
||||||
public abstract class BaseException
|
public abstract class BaseException
|
||||||
extends Exception
|
extends Exception
|
||||||
|
|
|
@ -24,7 +24,7 @@ import java.util.Objects;
|
||||||
/**
|
/**
|
||||||
* 带错误码的异常。
|
* 带错误码的异常。
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
*/
|
*/
|
||||||
public abstract class BaseRuntimeException
|
public abstract class BaseRuntimeException
|
||||||
extends RuntimeException
|
extends RuntimeException
|
||||||
|
|
|
@ -25,7 +25,7 @@ import java.util.function.DoubleFunction;
|
||||||
* <p>
|
* <p>
|
||||||
* 接受类型为 double 的参数,返回 {@code Optional<R>} 对象。
|
* 接受类型为 double 的参数,返回 {@code Optional<R>} 对象。
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
* @since 0.1.0
|
* @since 0.1.0
|
||||||
* @see Optional
|
* @see Optional
|
||||||
* @see DoubleFunction
|
* @see DoubleFunction
|
||||||
|
|
|
@ -25,7 +25,7 @@ import java.util.function.IntFunction;
|
||||||
* <p>
|
* <p>
|
||||||
* 接受类型为 int 的参数,返回 {@code Optional<R>} 对象。
|
* 接受类型为 int 的参数,返回 {@code Optional<R>} 对象。
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
* @since 0.1.0
|
* @since 0.1.0
|
||||||
* @see Optional
|
* @see Optional
|
||||||
* @see IntFunction
|
* @see IntFunction
|
||||||
|
|
|
@ -25,7 +25,7 @@ import java.util.function.LongFunction;
|
||||||
* <p>
|
* <p>
|
||||||
* 接受类型为 long 的参数,返回 {@code Optional<R>} 对象。
|
* 接受类型为 long 的参数,返回 {@code Optional<R>} 对象。
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
* @since 0.1.0
|
* @since 0.1.0
|
||||||
* @see Optional
|
* @see Optional
|
||||||
* @see LongFunction
|
* @see LongFunction
|
||||||
|
|
|
@ -25,7 +25,7 @@ import java.util.function.Supplier;
|
||||||
* <p>
|
* <p>
|
||||||
* 返回 {@link OptionalDouble} 对象。
|
* 返回 {@link OptionalDouble} 对象。
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
* @since 0.1.0
|
* @since 0.1.0
|
||||||
* @see OptionalDouble
|
* @see OptionalDouble
|
||||||
* @see Supplier
|
* @see Supplier
|
||||||
|
|
|
@ -25,7 +25,7 @@ import java.util.function.Supplier;
|
||||||
* <p>
|
* <p>
|
||||||
* 返回 {@link OptionalInt} 对象。
|
* 返回 {@link OptionalInt} 对象。
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
* @since 0.1.0
|
* @since 0.1.0
|
||||||
* @see OptionalInt
|
* @see OptionalInt
|
||||||
* @see Supplier
|
* @see Supplier
|
||||||
|
|
|
@ -25,7 +25,7 @@ import java.util.function.Supplier;
|
||||||
* <p>
|
* <p>
|
||||||
* 返回 {@link OptionalLong} 对象。
|
* 返回 {@link OptionalLong} 对象。
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
* @since 0.1.0
|
* @since 0.1.0
|
||||||
* @see OptionalLong
|
* @see OptionalLong
|
||||||
* @see Supplier
|
* @see Supplier
|
||||||
|
|
|
@ -25,7 +25,7 @@ import java.util.function.Supplier;
|
||||||
* <p>
|
* <p>
|
||||||
* 返回 {@code Optional<T>} 对象。
|
* 返回 {@code Optional<T>} 对象。
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
* @since 0.1.0
|
* @since 0.1.0
|
||||||
* @see Optional
|
* @see Optional
|
||||||
* @see Supplier
|
* @see Supplier
|
||||||
|
|
|
@ -25,7 +25,7 @@ import java.util.function.Predicate;
|
||||||
* {@link Predicate} 相关操作。
|
* {@link Predicate} 相关操作。
|
||||||
* </p>
|
* </p>
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
* @since 0.1.0
|
* @since 0.1.0
|
||||||
* @see Predicate
|
* @see Predicate
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -25,7 +25,7 @@ import java.util.function.BiFunction;
|
||||||
* <p>
|
* <p>
|
||||||
* 接受类型为 T 和 U 的两个参数,返回 {@code Optional<R>} 对象。
|
* 接受类型为 T 和 U 的两个参数,返回 {@code Optional<R>} 对象。
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
* @since 0.1.0
|
* @since 0.1.0
|
||||||
* @see Optional
|
* @see Optional
|
||||||
* @see BiFunction
|
* @see BiFunction
|
||||||
|
|
|
@ -25,7 +25,7 @@ import java.util.function.Function;
|
||||||
* <p>
|
* <p>
|
||||||
* 接受类型为 T 的参数,返回 {@link OptionalDouble} 对象。
|
* 接受类型为 T 的参数,返回 {@link OptionalDouble} 对象。
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
* @since 0.1.0
|
* @since 0.1.0
|
||||||
* @see OptionalDouble
|
* @see OptionalDouble
|
||||||
* @see Function
|
* @see Function
|
||||||
|
|
|
@ -25,7 +25,7 @@ import java.util.function.Function;
|
||||||
* <p>
|
* <p>
|
||||||
* 接受类型为 T 的参数,返回 {@code Optional<R>} 对象。
|
* 接受类型为 T 的参数,返回 {@code Optional<R>} 对象。
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
* @since 0.1.0
|
* @since 0.1.0
|
||||||
* @see Optional
|
* @see Optional
|
||||||
* @see Function
|
* @see Function
|
||||||
|
|
|
@ -25,7 +25,7 @@ import java.util.function.Function;
|
||||||
* <p>
|
* <p>
|
||||||
* 接受类型为 T 的参数,返回 {@link OptionalInt} 对象。
|
* 接受类型为 T 的参数,返回 {@link OptionalInt} 对象。
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
* @since 0.1.0
|
* @since 0.1.0
|
||||||
* @see OptionalInt
|
* @see OptionalInt
|
||||||
* @see Function
|
* @see Function
|
||||||
|
|
|
@ -25,7 +25,7 @@ import java.util.function.Function;
|
||||||
* <p>
|
* <p>
|
||||||
* 接受类型为 T 的参数,返回 {@link OptionalLong} 对象。
|
* 接受类型为 T 的参数,返回 {@link OptionalLong} 对象。
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
* @since 0.1.0
|
* @since 0.1.0
|
||||||
* @see OptionalLong
|
* @see OptionalLong
|
||||||
* @see Function
|
* @see Function
|
||||||
|
|
|
@ -25,7 +25,7 @@ import com.google.common.base.Preconditions;
|
||||||
/**
|
/**
|
||||||
* 枚举工具类
|
* 枚举工具类
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
*/
|
*/
|
||||||
public final class EnumTools {
|
public final class EnumTools {
|
||||||
|
|
||||||
|
|
|
@ -19,7 +19,7 @@ package xyz.zhouxy.plusone.commons.util;
|
||||||
/**
|
/**
|
||||||
* Numbers
|
* Numbers
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
*/
|
*/
|
||||||
public class Numbers {
|
public class Numbers {
|
||||||
|
|
||||||
|
|
|
@ -31,7 +31,7 @@ import com.google.common.annotations.Beta;
|
||||||
* <p>
|
* <p>
|
||||||
* 提供一些 Optional 相关的方法
|
* 提供一些 Optional 相关的方法
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
* @since 0.1.0
|
* @since 0.1.0
|
||||||
* @see Optional
|
* @see Optional
|
||||||
* @see OptionalInt
|
* @see OptionalInt
|
||||||
|
|
|
@ -27,7 +27,7 @@ import xyz.zhouxy.plusone.commons.annotation.StaticFactoryMethod;
|
||||||
*
|
*
|
||||||
* @param <T> 内容列表的元素类型
|
* @param <T> 内容列表的元素类型
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
* @see PagingAndSortingQueryParams
|
* @see PagingAndSortingQueryParams
|
||||||
*/
|
*/
|
||||||
public class PageDTO<T> {
|
public class PageDTO<T> {
|
||||||
|
|
|
@ -27,7 +27,7 @@ import com.google.common.base.Preconditions;
|
||||||
/**
|
/**
|
||||||
* 对返回给前端的数据进行封装
|
* 对返回给前端的数据进行封装
|
||||||
*
|
*
|
||||||
* @author <a href="https://gitee.com/zhouxy108">ZhouXY</a>
|
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
|
||||||
* @deprecated 已被 {@link UnifiedResponse} 代替。
|
* @deprecated 已被 {@link UnifiedResponse} 代替。
|
||||||
*/
|
*/
|
||||||
@Deprecated
|
@Deprecated
|
||||||
|
|
Loading…
Reference in New Issue