• Home
• com.softicar.platform
• platform-common
• 45.0.1
• source code
• ISourceCodeReferencePoint.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.softicar.platform.common.code.reference.point.ISourceCodeReferencePoint Maven / Gradle / Ivy

package com.softicar.platform.common.code.reference.point;

import com.softicar.platform.common.core.i18n.IDisplayString;
import com.softicar.platform.common.core.i18n.IDisplayable;
import java.util.UUID;

/**
 * Implemented by classes representing reference points in the source code.
 * 

 * Classes implementing this interface need to define a {@link UUID} by using
 * the annotation {@link SourceCodeReferencePointUuid}.
 *
 * @author Oliver Richers
 */
public interface ISourceCodeReferencePoint extends IDisplayable {

	/**
	 * The default implementation returns the canonical name of this class.
	 *
	 * @return the canonical class name (never null)
	 */
	@Override
	default IDisplayString toDisplay() {

		return IDisplayString.create(getClass().getSimpleName());
	}

	/**
	 * Returns the {@link UUID} that uniquely identifies this
	 * {@link ISourceCodeReferencePoint}.
	 * 

	 * Throws an {@link Exception} if this class has no valid
	 * {@link SourceCodeReferencePointUuid} annotation.
	 *
	 * @return the {@link UUID} (never null)
	 */
	default UUID getAnnotatedUuid() {

		return SourceCodeReferencePoints.getUuidOrThrow(getClass());
	}
}