com.opcooc.captcha.autoconfigure.CaptchaWatermarkProperties Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2020-2021 organization opcooc ([email protected])
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.opcooc.captcha.autoconfigure;


import com.opcooc.captcha.enums.WatermarkType;

import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

/**
 * @author opcooc
 */
@Getter
@Setter
@NoArgsConstructor
public class CaptchaWatermarkProperties {

    /**
     * 背景类型
     *
     * @param type 参数
     * @return 值
     */
    private WatermarkType type = WatermarkType.FONT;
    /**
     * 水印偏差偏移
     *
     * @param offset 参数
     * @return 值
     */
    private Integer offset = 7;
    /**
     * 水印信息
     *
     * @param text 参数
     * @return 值
     */
    private String text = "我是水印";
    /**
     * 水印文件路径
     *
     * @param image 参数
     * @return 值
     */
    private String image;
    /**
     * 文字大小
     *
     * @param fontSize 参数
     * @return 值
     */
    private Integer fontSize = 25;

    /**
     * 水印文字字体，默认 '宋体'
     *
     * @param fontType 参数
     * @return 值
     */
    private String fontType = "宋体";

    /**
     * 是否开启水印功能
     *
     * @param enable 参数
     * @return 值
     */
    private boolean enable = false;
}