fix comment

This commit is contained in:
Looly 2020-12-16 14:50:47 +08:00
parent f47de0590d
commit 217457ac10
2 changed files with 49 additions and 46 deletions

View File

@ -16,15 +16,15 @@ import java.nio.charset.Charset;
* 也就是三位二进制数组经过编码后变为四位的ASCII字符显示长度比原来增加1/3 * 也就是三位二进制数组经过编码后变为四位的ASCII字符显示长度比原来增加1/3
* *
* @author Looly * @author Looly
*
*/ */
public class Base64 { public class Base64 {
// -------------------------------------------------------------------- encode // -------------------------------------------------------------------- encode
/** /**
* 编码为Base64非URL安全的 * 编码为Base64非URL安全的
* *
* @param arr 被编码的数组 * @param arr 被编码的数组
* @param lineSep 在76个char之后是CRLF还是EOF * @param lineSep 在76个char之后是CRLF还是EOF
* @return 编码后的bytes * @return 编码后的bytes
*/ */
@ -35,7 +35,7 @@ public class Base64 {
/** /**
* 编码为Base64URL安全的 * 编码为Base64URL安全的
* *
* @param arr 被编码的数组 * @param arr 被编码的数组
* @param lineSep 在76个char之后是CRLF还是EOF * @param lineSep 在76个char之后是CRLF还是EOF
* @return 编码后的bytes * @return 编码后的bytes
* @since 3.0.6 * @since 3.0.6
@ -68,7 +68,7 @@ public class Base64 {
/** /**
* base64编码 * base64编码
* *
* @param source 被编码的base64字符串 * @param source 被编码的base64字符串
* @param charset 字符集 * @param charset 字符集
* @return 被加密后的字符串 * @return 被加密后的字符串
*/ */
@ -79,7 +79,8 @@ public class Base64 {
/** /**
* base64编码不进行padding(末尾不会填充'=') * base64编码不进行padding(末尾不会填充'=')
* *
* @param source 被编码的base64字符串 * @param source 被编码的base64字符串
* @param charset 编码
* @return 被加密后的字符串 * @return 被加密后的字符串
* @since 5.5.2 * @since 5.5.2
*/ */
@ -90,7 +91,7 @@ public class Base64 {
/** /**
* base64编码,URL安全 * base64编码,URL安全
* *
* @param source 被编码的base64字符串 * @param source 被编码的base64字符串
* @param charset 字符集 * @param charset 字符集
* @return 被加密后的字符串 * @return 被加密后的字符串
* @since 3.0.6 * @since 3.0.6
@ -102,7 +103,7 @@ public class Base64 {
/** /**
* base64编码 * base64编码
* *
* @param source 被编码的base64字符串 * @param source 被编码的base64字符串
* @param charset 字符集 * @param charset 字符集
* @return 被加密后的字符串 * @return 被加密后的字符串
*/ */
@ -113,7 +114,7 @@ public class Base64 {
/** /**
* base64编码URL安全的 * base64编码URL安全的
* *
* @param source 被编码的base64字符串 * @param source 被编码的base64字符串
* @param charset 字符集 * @param charset 字符集
* @return 被加密后的字符串 * @return 被加密后的字符串
* @since 3.0.6 * @since 3.0.6
@ -200,11 +201,11 @@ public class Base64 {
/** /**
* 编码为Base64<br> * 编码为Base64<br>
* 如果isMultiLine为<code>true</code>则每76个字符一个换行符否则在一行显示 * 如果isMultiLine为{@code true}则每76个字符一个换行符否则在一行显示
* *
* @param arr 被编码的数组 * @param arr 被编码的数组
* @param isMultiLine 在76个char之后是CRLF还是EOF * @param isMultiLine 在76个char之后是CRLF还是EOF
* @param isUrlSafe 是否使用URL安全字符一般为<code>false</code> * @param isUrlSafe 是否使用URL安全字符一般为{@code false}
* @return 编码后的bytes * @return 编码后的bytes
*/ */
public static byte[] encode(byte[] arr, boolean isMultiLine, boolean isUrlSafe) { public static byte[] encode(byte[] arr, boolean isMultiLine, boolean isUrlSafe) {
@ -212,6 +213,7 @@ public class Base64 {
} }
// -------------------------------------------------------------------- decode // -------------------------------------------------------------------- decode
/** /**
* base64解码 * base64解码
* *
@ -236,7 +238,7 @@ public class Base64 {
/** /**
* base64解码 * base64解码
* *
* @param source 被解码的base64字符串 * @param source 被解码的base64字符串
* @param charset 字符集 * @param charset 字符集
* @return 被加密后的字符串 * @return 被加密后的字符串
*/ */
@ -247,7 +249,7 @@ public class Base64 {
/** /**
* base64解码 * base64解码
* *
* @param source 被解码的base64字符串 * @param source 被解码的base64字符串
* @param charset 字符集 * @param charset 字符集
* @return 被加密后的字符串 * @return 被加密后的字符串
*/ */
@ -258,7 +260,7 @@ public class Base64 {
/** /**
* base64解码 * base64解码
* *
* @param base64 被解码的base64字符串 * @param base64 被解码的base64字符串
* @param destFile 目标文件 * @param destFile 目标文件
* @return 目标文件 * @return 目标文件
* @since 4.0.9 * @since 4.0.9
@ -270,8 +272,8 @@ public class Base64 {
/** /**
* base64解码 * base64解码
* *
* @param base64 被解码的base64字符串 * @param base64 被解码的base64字符串
* @param out 写出到的流 * @param out 写出到的流
* @param isCloseOut 是否关闭输出流 * @param isCloseOut 是否关闭输出流
* @since 4.0.9 * @since 4.0.9
*/ */
@ -292,10 +294,10 @@ public class Base64 {
/** /**
* base64解码 * base64解码
* *
* @param source 被解码的base64字符串 * @param source 被解码的base64字符串
* @param charset 字符集 * @param charset 字符集
* @return 被加密后的字符串 * @return 被加密后的字符串
*@deprecated 编码参数无意义作废 * @deprecated 编码参数无意义作废
*/ */
@Deprecated @Deprecated
public static byte[] decode(CharSequence source, String charset) { public static byte[] decode(CharSequence source, String charset) {
@ -305,10 +307,10 @@ public class Base64 {
/** /**
* base64解码 * base64解码
* *
* @param source 被解码的base64字符串 * @param source 被解码的base64字符串
* @param charset 字符集 * @param charset 字符集
* @return 被加密后的字符串 * @return 被加密后的字符串
*@deprecated 编码参数无意义作废 * @deprecated 编码参数无意义作废
*/ */
@Deprecated @Deprecated
public static byte[] decode(CharSequence source, Charset charset) { public static byte[] decode(CharSequence source, Charset charset) {

View File

@ -563,6 +563,7 @@ public class ZipUtil {
* 获取压缩包中的指定文件流 * 获取压缩包中的指定文件流
* *
* @param zipFile 压缩文件 * @param zipFile 压缩文件
* @param charset 编码
* @param path 需要提取文件的文件名或路径 * @param path 需要提取文件的文件名或路径
* @return 压缩文件流如果未找到返回{@code null} * @return 压缩文件流如果未找到返回{@code null}
* @since 5.5.2 * @since 5.5.2