org.frankframework.doc.DocumentedEnum Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of frankframework-commons Show documentation

There is a newer version: 8.3.0

Show newest version

/*
   Copyright 2021 WeAreFrank!

   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 org.frankframework.doc;

import java.lang.reflect.Field;

public interface DocumentedEnum {

	/**
	 * @return Optional 'FieldName' or label that's used to parse the Enum, should never be null but return name() instead!
	 */
	default String getLabel() {
		Field enumConstant;
		try {
			enumConstant = getClass().getField(name());
		} catch(NoSuchFieldException e) {
			return name();
		}
		if(enumConstant.isAnnotationPresent(EnumLabel.class)) {
			EnumLabel enumLabel = enumConstant.getAnnotation(EnumLabel.class);
			return enumLabel.value();
		}
		return name();
	}

	// returns the fieldName of the enum.
	String name();
}