Package org.kohsuke.accmod.restrictions

Class DoNotUse

java.lang.Object

org.kohsuke.accmod.AccessRestriction

org.kohsuke.accmod.restrictions.DoNotUse

Direct Known Subclasses:

Beta, NoExternalUse

public class DoNotUse
extends AccessRestriction

This type, field, or method shall never be referenced from anywhere at all.

Author:

Kohsuke Kawaguchi

Field Summary

Fields inherited from class org.kohsuke.accmod.AccessRestriction

NONE

Constructor Summary

Constructors

Constructor	Description
DoNotUse()

Method Summary

Modifier and Type	Method	Description
boolean	appliesToNested()	Whether this access restriction, if applied to a type, should also be considered to apply implicitly to all transitively nested members.
void	error(Location loc, RestrictedElement target, ErrorListener errorListener)
void	instantiated(Location loc, RestrictedElement target, ErrorListener errorListener)	The type on which this restriction is placed is instantiated elsewhere.
void	invoked(Location loc, RestrictedElement target, ErrorListener errorListener)	The method on which this restriction is placed is invoked elsewhere.
void	read(Location loc, RestrictedElement target, ErrorListener errorListener)	The field on which this restriction is placed is read.
void	usedAsInterface(Location loc, RestrictedElement target, ErrorListener errorListener)	The type on which this restriction is placed is used as an interface that another class/interface implements.
void	usedAsSuperType(Location loc, RestrictedElement target, ErrorListener errorListener)	The type on which this restriction is placed is used as a supertype by another class.
void	written(Location loc, RestrictedElement target, ErrorListener errorListener)	The field on which this restriction is placed is updated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DoNotUse

public DoNotUse()

Method Detail

written

public void written(Location loc,
                    RestrictedElement target,
                    ErrorListener errorListener)

Description copied from class: AccessRestriction

The field on which this restriction is placed is updated.

Specified by:

written in class AccessRestriction

usedAsSuperType

public void usedAsSuperType(Location loc,
                            RestrictedElement target,
                            ErrorListener errorListener)

Description copied from class: AccessRestriction

The type on which this restriction is placed is used as a supertype by another class. The location points to the subtype.

Specified by:

usedAsSuperType in class AccessRestriction

Parameters:

loc - Points to the subtype.

errorListener - Report any error here.

usedAsInterface

public void usedAsInterface(Location loc,
                            RestrictedElement target,
                            ErrorListener errorListener)

Description copied from class: AccessRestriction

The type on which this restriction is placed is used as an interface that another class/interface implements.

Specified by:

usedAsInterface in class AccessRestriction

Parameters:

loc - Points to the subtype.

errorListener - Report any error here.

instantiated

public void instantiated(Location loc,
                         RestrictedElement target,
                         ErrorListener errorListener)

Description copied from class: AccessRestriction

The type on which this restriction is placed is instantiated elsewhere.

Specified by:

instantiated in class AccessRestriction

invoked

public void invoked(Location loc,
                    RestrictedElement target,
                    ErrorListener errorListener)

Description copied from class: AccessRestriction

The method on which this restriction is placed is invoked elsewhere.

Specified by:

invoked in class AccessRestriction

read

public void read(Location loc,
                 RestrictedElement target,
                 ErrorListener errorListener)

Description copied from class: AccessRestriction

The field on which this restriction is placed is read.

Specified by:

read in class AccessRestriction

error

public void error(Location loc,
                  RestrictedElement target,
                  ErrorListener errorListener)

appliesToNested

public boolean appliesToNested()

Description copied from class: AccessRestriction

Whether this access restriction, if applied to a type, should also be considered to apply implicitly to all transitively nested members.

Overrides:

appliesToNested in class AccessRestriction

Returns:

by default, false