net.java.truevfs.access

Annotation Type ExpertFeature

@Documented
 @Inherited
 @Target(value={CONSTRUCTOR,METHOD})
public @interface ExpertFeature

Indicates a feature which requires a certain experience level for safe use. In most cases, using an expert feature is a code smell and you should refactor your code to avoid it in order to stay safe. However, some valid use cases exist for an expert feature (otherwise it should have been @Deprecated). These use cases are not explained here because a true expert will know them!

As of TrueVFS 0.10, using an expert feature is not checked. However, future versions of TrueVFS might include tools to issue a warning whenever an expert feature is unintentionally used - similar to the way javac treats the @Deprecated annotation.

Since:

TrueVFS 0.10

Author:

Christian Schlichtherle

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
ExpertFeature.Reason[]	value Returns the reasons why this feature should only be used by an expert.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
ExpertFeature.Level	level Returns the experience level required to safely use this feature.
String	warning Returns a warning message for future use, for example in static code analysis.

Element Detail

value

public abstract ExpertFeature.Reason[] value

Returns the reasons why this feature should only be used by an expert.

level

public abstract ExpertFeature.Level level

Returns the experience level required to safely use this feature.

Default:

net.java.truevfs.access.ExpertFeature.Level.MASTER

warning

public abstract String warning

Returns a warning message for future use, for example in static code analysis.

Default:

"Using this %s requires %s experience because %s!"