From d5ab77ddbd9ba43602643b856ba69f820c6610b5 Mon Sep 17 00:00:00 2001 From: jiangjining Date: Thu, 7 Jan 2021 20:35:55 +0800 Subject: [PATCH] docs: Add translations for some entities in PowerJob-common. --- .../kfcfans/powerjob/client/OhMyClient.java | 2 +- .../powerjob/common/ContainerConstant.java | 9 ++++++--- .../github/kfcfans/powerjob/common/Env.java | 11 ++++++++++- .../kfcfans/powerjob/common/ExecuteType.java | 11 ++++++++++- .../kfcfans/powerjob/common/OmsConstant.java | 2 +- .../powerjob/common/OmsSerializable.java | 2 +- .../common/model/InstanceLogContent.java | 18 +++++++++++++----- 7 files changed, 42 insertions(+), 13 deletions(-) diff --git a/powerjob-client/src/main/java/com/github/kfcfans/powerjob/client/OhMyClient.java b/powerjob-client/src/main/java/com/github/kfcfans/powerjob/client/OhMyClient.java index 72d0a788..9a8a980e 100644 --- a/powerjob-client/src/main/java/com/github/kfcfans/powerjob/client/OhMyClient.java +++ b/powerjob-client/src/main/java/com/github/kfcfans/powerjob/client/OhMyClient.java @@ -25,7 +25,7 @@ import java.util.Objects; import static com.github.kfcfans.powerjob.client.TypeStore.*; /** - * OpenAPI Client. + * OhMyClient, the client for OpenAPI. * * @author tjq * @since 2020/4/15 diff --git a/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/ContainerConstant.java b/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/ContainerConstant.java index ab8cc275..06b00697 100644 --- a/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/ContainerConstant.java +++ b/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/ContainerConstant.java @@ -1,7 +1,7 @@ package com.github.kfcfans.powerjob.common; /** - * 容器常量 + * Container constants. * * @author tjq * @since 2020/5/15 @@ -9,13 +9,16 @@ package com.github.kfcfans.powerjob.common; public class ContainerConstant { /** - * spring-context 配置文件名称 + * Spring-context configuration file name of the container. */ public static final String SPRING_CONTEXT_FILE_NAME = "oms-worker-container-spring-context.xml"; /** - * container 属性文件名称 + * Property file name of the container. */ public static final String CONTAINER_PROPERTIES_FILE_NAME = "oms-worker-container.properties"; + /** + * Package name of the container. + */ public static final String CONTAINER_PACKAGE_NAME_KEY = "PACKAGE_NAME"; } diff --git a/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/Env.java b/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/Env.java index e5344061..25906112 100644 --- a/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/Env.java +++ b/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/Env.java @@ -1,13 +1,22 @@ package com.github.kfcfans.powerjob.common; /** - * 部署环境 + * Environment Enum class. * * @author tjq * @since 2020/5/3 */ public enum Env { + /** + * Development or test environment. + */ DAILY, + /** + * Pre-release environment. + */ PRE, + /** + * Production environment. + */ PRODUCT } diff --git a/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/ExecuteType.java b/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/ExecuteType.java index 5f46d9ec..7ee38b53 100644 --- a/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/ExecuteType.java +++ b/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/ExecuteType.java @@ -4,7 +4,7 @@ import lombok.AllArgsConstructor; import lombok.Getter; /** - * 任务执行类型 + * Execution type. * * @author tjq * @since 2020/3/17 @@ -12,8 +12,17 @@ import lombok.Getter; @Getter @AllArgsConstructor public enum ExecuteType { + /** + * Standalone type of task. + */ STANDALONE(1, "单机执行"), + /** + * Broadcast type of task. + */ BROADCAST(2, "广播执行"), + /** + * MapReduce type of task. + */ MAP_REDUCE(3, "MapReduce"), MAP(4, "Map"); diff --git a/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/OmsConstant.java b/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/OmsConstant.java index 3cb99e5e..a2a79fd4 100644 --- a/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/OmsConstant.java +++ b/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/OmsConstant.java @@ -1,7 +1,7 @@ package com.github.kfcfans.powerjob.common; /** - * 公共常量 + * Common constants. * * @author tjq * @since 2020/5/31 diff --git a/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/OmsSerializable.java b/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/OmsSerializable.java index 36243db5..aa132dad 100644 --- a/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/OmsSerializable.java +++ b/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/OmsSerializable.java @@ -3,7 +3,7 @@ package com.github.kfcfans.powerjob.common; import java.io.Serializable; /** - * PowerJob 序列化标记接口 + * PowerJob serializable interface. * * @author tjq * @since 2020/4/16 diff --git a/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/model/InstanceLogContent.java b/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/model/InstanceLogContent.java index 0be65e93..ce588945 100644 --- a/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/model/InstanceLogContent.java +++ b/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/model/InstanceLogContent.java @@ -6,7 +6,7 @@ import lombok.Data; import lombok.NoArgsConstructor; /** - * 任务实例日志对象 + * Log instance model. * * @author tjq * @since 2020/4/21 @@ -16,13 +16,21 @@ import lombok.NoArgsConstructor; @AllArgsConstructor public class InstanceLogContent implements OmsSerializable { - // 实例ID + /** + * Id of instance. + */ private long instanceId; - // 日志提交时间 + /** + * Submitted time of the log. + */ private long logTime; - // 级别 + /** + * Level of the log. + */ private int logLevel; - // 日志内容 + /** + * Content of the log. + */ private String logContent; }