IDocumented Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
If the annotation @Documented is present on the declaration
of an annotation interface A, then any @A annotation on
an element is considered part of the element's public contract.
[Android.Runtime.Register("java/lang/annotation/Documented", "", "Java.Lang.Annotation.IDocumentedInvoker")]
public interface IDocumented : IDisposable, Java.Interop.IJavaPeerable, Java.Lang.Annotation.IAnnotation[<Android.Runtime.Register("java/lang/annotation/Documented", "", "Java.Lang.Annotation.IDocumentedInvoker")>]
type IDocumented = interface
interface IAnnotation
interface IJavaObject
interface IDisposable
interface IJavaPeerable- Attributes
- Implements
Remarks
If the annotation @Documented is present on the declaration of an annotation interface A, then any @A annotation on an element is considered part of the element's public contract.
In more detail, when an annotation interface A is annotated with Documented, the presence and value of A annotations are a part of the public contract of the elements A annotates.
Conversely, if an annotation interface B is <em>not</em> annotated with Documented, the presence and value of B annotations are <em>not</em> part of the public contract of the elements B annotates.
Concretely, if an annotation interface is annotated with Documented, by default a tool like javadoc will display annotations of that interface in its output while annotations of annotation interfaces without Documented will not be displayed.
Added in 1.5.
Java documentation for java.lang.annotation.Documented.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
Properties
| Handle |
Gets the JNI value of the underlying Android object. (Inherited from IJavaObject) |
| JniIdentityHashCode |
Returns the value of |
| JniManagedPeerState |
State of the managed peer. (Inherited from IJavaPeerable) |
| JniPeerMembers |
Member access and invocation support. (Inherited from IJavaPeerable) |
| PeerReference |
Returns a JniObjectReference of the wrapped Java object instance. (Inherited from IJavaPeerable) |
Methods
| AnnotationType() |
Returns the annotation interface of this annotation. (Inherited from IAnnotation) |
| Disposed() |
Called when the instance has been disposed. (Inherited from IJavaPeerable) |
| DisposeUnlessReferenced() |
If there are no outstanding references to this instance, then
calls |
| Equals(Object) |
Returns true if the specified object represents an annotation that is logically equivalent to this one. (Inherited from IAnnotation) |
| Finalized() |
Called when the instance has been finalized. (Inherited from IJavaPeerable) |
| GetHashCode() |
Returns the hash code of this annotation. (Inherited from IAnnotation) |
| SetJniIdentityHashCode(Int32) |
Set the value returned by |
| SetJniManagedPeerState(JniManagedPeerStates) | (Inherited from IJavaPeerable) |
| SetPeerReference(JniObjectReference) |
Set the value returned by |
| ToString() |
Returns a string representation of this annotation. (Inherited from IAnnotation) |
| UnregisterFromRuntime() |
Unregister this instance so that the runtime will not return it from future Java.Interop.JniRuntime+JniValueManager.PeekValue invocations. (Inherited from IJavaPeerable) |
Extension Methods
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) | |
| GetJniTypeName(IJavaPeerable) | |