me.remigio07.chatplugin.api.common.util.annotation.SensitiveData Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api Show documentation

A complete yet lightweight plugin which handles just too many features!

There is a newer version: 1.9.10

/*
 * 	ChatPlugin - A complete yet lightweight plugin which handles just too many features!
 * 	Copyright 2024  Remigio07
 * 	
 * 	This program is distributed in the hope that it will be useful,
 * 	but WITHOUT ANY WARRANTY; without even the implied warranty of
 * 	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * 	GNU Affero General Public License for more details.
 * 	
 * 	You should have received a copy of the GNU Affero General Public License
 * 	along with this program.  If not, see .
 * 	
 * 	
 */

package me.remigio07.chatplugin.api.common.util.annotation;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * Annotation used to indicate that a field or a method contains or returns
 * sensitive or private data, like for example the Discord integration's bot's token.
 * 
 * The managers' (even the addons' ones) debugger will not
 * print the values of variables denoted by this annotation.
 */
@Target({ FIELD, METHOD })
@Retention(RUNTIME)
public @interface SensitiveData {
	
	/**
	 * Short explanation of why the data is sensitive.
	 * 
	 * @return Warning message
	 */
	public String warning();
	
}