IDocumented 介面

定義

命名空間:

Java.Lang.Annotation

組件:

Mono.Android.dll

如果註解 @Documented 存在於註解介面 A 的宣告中，則元素上的任何 @A 註解都被視為該元素公開契約的一部分。

[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

屬性

RegisterAttribute

實作

IJavaObject IJavaPeerable IAnnotation IDisposable

備註

如果註解 @Documented 存在於註解介面 A 的宣告中，則元素上的任何 @A 註解都被視為該元素公開契約的一部分。

更詳細地說，當註解介面 A 被註解為 Documented時，A 標註的存在與價值是 A 所註解元素的公共契約的一部分。

反之，若註解介面 B 是 <em>not</em> 註Documented解為 ，則 B 標註的存在與價值屬於 <><>B 所註解元素的公共契約。

具體來說，如果註解介面標註為 Documented，像 javadoc 這類工具預設會在輸出中顯示該介面的註解，而沒有 Documented 標註介面的註解則不會顯示。

已在1.5中新增。

的 java.lang.annotation.DocumentedJava 檔。

本頁部分內容為基於 Open Source Project 所創建與分享的作品，並依授權條款所描述的使用進行修改。

屬性

名稱	Description
Handle	取得底層 Android 物件的 JNI 值。 (繼承來源 IJavaObject)
JniIdentityHashCode	回傳包裹實例的 java.lang.System.identityHashCode() 值。 (繼承來源 IJavaPeerable)
JniManagedPeerState	管理貴族的狀況。 (繼承來源 IJavaPeerable)
JniObjectReferenceControlBlock	如果註解 @Documented 存在於註解介面 A 的宣告中，則元素上的任何 @A 註解都被視為該元素公開契約的一部分。 (繼承來源 IJavaPeerable)
JniPeerMembers	成員存取與召喚支援。 (繼承來源 IJavaPeerable)
PeerReference	回傳JniObjectReference包裹後的 Java 物件實例。 (繼承來源 IJavaPeerable)

方法

名稱	Description
AnnotationType()	回傳該註解的註解介面。 (繼承來源 IAnnotation)
Disposed()	當實例被處理後才被召喚。 (繼承來源 IJavaPeerable)
DisposeUnlessReferenced()	如果沒有未解決的參考資料，則 Dispose()呼叫;否則，則不做任何事。 (繼承來源 IJavaPeerable)
Equals(Object)	若指定物件代表與此標註邏輯等價，則返回真。 (繼承來源 IAnnotation)
Finalized()	當實例完成後才會被通知。 (繼承來源 IJavaPeerable)
GetHashCode()	回傳此註解的雜湊碼。 (繼承來源 IAnnotation)
SetJniIdentityHashCode(Int32)	將回傳的值設為 JniIdentityHashCode。 (繼承來源 IJavaPeerable)
SetJniManagedPeerState(JniManagedPeerStates)	如果註解 @Documented 存在於註解介面 A 的宣告中，則元素上的任何 @A 註解都被視為該元素公開契約的一部分。 (繼承來源 IJavaPeerable)
SetPeerReference(JniObjectReference)	將回傳的值設為 PeerReference。 (繼承來源 IJavaPeerable)
ToString()	回傳此註解的字串表示。 (繼承來源 IAnnotation)
UnregisterFromRuntime()	取消註冊此實例，讓執行時不會在未來 Java.Interop.JniRuntime+JniValueManager.PeekValue 的呼叫中回傳該實例。 (繼承來源 IJavaPeerable)

擴充方法

名稱	Description
GetJniTypeName(IJavaPeerable)	取得實例 self類型的 JNI 名稱。
JavaAs<TResult>(IJavaPeerable)	試著強制self輸入 TResult，檢查 強制在 Java 端是否有效。
JavaCast<TResult>(IJavaObject)	執行 Android 執行時檢查型別轉換。
JavaCast<TResult>(IJavaObject)	如果註解 @Documented 存在於註解介面 A 的宣告中，則元素上的任何 @A 註解都被視為該元素公開契約的一部分。
TryJavaCast<TResult>(IJavaPeerable, TResult)	試著強制self輸入 TResult，檢查 強制在 Java 端是否有效。