From b7cb58538e6371d97fecb399d5d35f514dca4351 Mon Sep 17 00:00:00 2001 From: Eike Stepper Date: Sat, 7 Jan 2012 14:16:08 +0100 Subject: Regen docs --- .../CDOView.Options.InvalidationPolicyEvent.html | 4 +- .../CDOView.Options.LoadNotificationEvent.html | 215 +++++++++++++++++++++ .../view/CDOView.Options.LoadNotificationEvent.png | Bin 0 -> 2482 bytes .../view/CDOView.Options.ReferencePolicyEvent.html | 4 +- .../org/eclipse/emf/cdo/view/CDOView.Options.html | 151 +++++++++++---- .../javadoc/org/eclipse/emf/cdo/view/CDOView.html | 109 ++++++++--- .../javadoc/org/eclipse/emf/cdo/view/CDOView.png | Bin 51274 -> 59339 bytes .../CDOView.Options.LoadNotificationEvent.html | 143 ++++++++++++++ .../eclipse/emf/cdo/view/class-use/CDOView.html | 2 +- .../org/eclipse/emf/cdo/view/package-frame.html | 2 + .../org/eclipse/emf/cdo/view/package-summary.html | 5 + 11 files changed, 560 insertions(+), 75 deletions(-) create mode 100644 plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.Options.LoadNotificationEvent.html create mode 100644 plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.Options.LoadNotificationEvent.png create mode 100644 plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/class-use/CDOView.Options.LoadNotificationEvent.html (limited to 'plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view') diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.Options.InvalidationPolicyEvent.html b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.Options.InvalidationPolicyEvent.html index 93a5628e31..59f884c7a1 100644 --- a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.Options.InvalidationPolicyEvent.html +++ b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.Options.InvalidationPolicyEvent.html @@ -56,7 +56,7 @@ function windowTitle()  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   @@ -182,7 +182,7 @@ An  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.Options.LoadNotificationEvent.html b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.Options.LoadNotificationEvent.html new file mode 100644 index 0000000000..089a1c5cb1 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.Options.LoadNotificationEvent.html @@ -0,0 +1,215 @@ + + + + + + +CDOView.Options.LoadNotificationEvent (CDO Model Repository Documentation) + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Use  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.eclipse.emf.cdo.view +
+Interface CDOView.Options.LoadNotificationEvent

+
+
All Superinterfaces:
IEvent, IOptionsEvent
+
+
+
Enclosing interface:
CDOView.Options
+
+
+
+
public static interface CDOView.Options.LoadNotificationEvent +
extends IOptionsEvent +
+ + + + + + +
+ + + +

+An options event fired from view options when the + load notification enabled option has changed. +

+ +

+

+
Since:
+
4.1
+
No Implement
+
This interface is not intended to be implemented by clients.
+
No Extend
+
This interface is not intended to be extended by clients.
+
+
+ +

+ + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from interface org.eclipse.net4j.util.options.IOptionsEvent
getSource
+  +

+ +

+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Use  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) and others. + + diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.Options.LoadNotificationEvent.png b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.Options.LoadNotificationEvent.png new file mode 100644 index 0000000000..e1b1a93023 Binary files /dev/null and b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.Options.LoadNotificationEvent.png differ diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.Options.ReferencePolicyEvent.html b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.Options.ReferencePolicyEvent.html index bb45610081..51c4fa1282 100644 --- a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.Options.ReferencePolicyEvent.html +++ b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.Options.ReferencePolicyEvent.html @@ -55,7 +55,7 @@ function windowTitle() - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   @@ -179,7 +179,7 @@ An - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.Options.html b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.Options.html index 22bb4c2103..d283509dd7 100644 --- a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.Options.html +++ b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.Options.html @@ -191,6 +191,15 @@ Encapsulates a set of notifying static interface +CDOView.Options.LoadNotificationEvent + +
+          An options event fired from view options when the + load notification enabled option has changed. + + + +static interface CDOView.Options.ReferencePolicyEvent
@@ -353,6 +362,16 @@ Encapsulates a set of notifying + boolean +isLoadNotificationEnabled() + +
+          Returns true if the objects in this view will notify their + adapters about the fact that they are loaded, + false otherwise. + + +  void removeChangeSubscriptionPolicy(CDOAdapterPolicy policy) @@ -389,6 +408,15 @@ Encapsulates a set of notifying  void +setLoadNotificationEnabled(boolean enabled) + +
+          Specifies whether the objects in this view will notify their + adapters about the fact that they are loaded or not. + + + + void setRevisionPrefetchingPolicy(CDORevisionPrefetchingPolicy prefetchingPolicy)
@@ -499,107 +527,109 @@ getContainer
-

-getCacheReferenceType

+

+isLoadNotificationEnabled

-ReferenceType getCacheReferenceType()
+boolean isLoadNotificationEnabled()
-
Returns the reference type to be used in the internal object cache. +
Returns true if the objects in this view will notify their + adapters about the fact that they are loaded, + false otherwise.

- -
Returns:
Either STRONG, SOFT or WEAK.
+
Since:
+
4.1
+
-

-setCacheReferenceType

+

+setLoadNotificationEnabled

-boolean setCacheReferenceType(ReferenceType referenceType)
+void setLoadNotificationEnabled(boolean enabled)
-
Sets the reference type to be used in the internal object cache to either STRONG, - SOFT or WEAK. If null is passed the default - reference type SOFT is set. If the given reference type does not differ from the one - being currently set the new value is ignored and false is returned. Otherwise existing object - references are converted to the new type and true is returned. +
Specifies whether the objects in this view will notify their + adapters about the fact that they are loaded or not.

+
Since:
+
4.1
-

-getInvalidationPolicy

+

+isInvalidationNotificationEnabled

-CDOInvalidationPolicy getInvalidationPolicy()
+boolean isInvalidationNotificationEnabled()
+
Returns true if the objects in this view will notify their + adapters about the fact that they are invalidated (due to + remote changes), false otherwise. +

-
Since:
-
3.0
-
+
See Also:
CDOInvalidationNotification
-

-setInvalidationPolicy

+

+setInvalidationNotificationEnabled

-void setInvalidationPolicy(CDOInvalidationPolicy policy)
+void setInvalidationNotificationEnabled(boolean enabled)
+
Specifies whether the objects in this view will notify their + adapters about the fact that they are invalidated (due to + remote changes) or not. +

-
Since:
-
3.0
-
+
See Also:
CDOInvalidationNotification
-

-isInvalidationNotificationEnabled

+

+getInvalidationPolicy

-boolean isInvalidationNotificationEnabled()
+CDOInvalidationPolicy getInvalidationPolicy()
-
Returns true if the objects in this view will notify their - adapters about the fact that they are invalidated (due to - remote changes), false otherwise. -

-
See Also:
CDOInvalidationNotification
+
Since:
+
3.0
+
-

-setInvalidationNotificationEnabled

+

+setInvalidationPolicy

-void setInvalidationNotificationEnabled(boolean enabled)
+void setInvalidationPolicy(CDOInvalidationPolicy policy)
-
Specifies whether the objects in this view will notify their - adapters about the fact that they are invalidated (due to - remote changes) or not. -

-
See Also:
CDOInvalidationNotification
+
Since:
+
3.0
+
@@ -679,6 +709,43 @@ void removeChangeSubscriptionPolicy(

+getCacheReferenceType

+
+ReferenceType getCacheReferenceType()
+
+
Returns the reference type to be used in the internal object cache. +

+

+
+
+
+ +
Returns:
Either STRONG, SOFT or WEAK.
+
+
+
+ +

+setCacheReferenceType

+
+boolean setCacheReferenceType(ReferenceType referenceType)
+
+
Sets the reference type to be used in the internal object cache to either STRONG, + SOFT or WEAK. If null is passed the default + reference type SOFT is set. If the given reference type does not differ from the one + being currently set the new value is ignored and false is returned. Otherwise existing object + references are converted to the new type and true is returned. +

+

+
+
+
+
+
+
+
+

getStrongReferencePolicy

diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.html b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.html
index 2209e2e484..eb6debffcb 100644
--- a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.html
+++ b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.html
@@ -108,22 +108,23 @@ Interface CDOView
 
 
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
 
 

@@ -252,12 +253,29 @@ A read-only view to the state of the object graph in the repository of the under
 
 
 
+ void
+disableDurableLocking(boolean releaseLocks)
+
+

+          Disables the storage of all information that's needed to reopen this view at a
+ later point in time.
+
+
+
+ String
+enableDurableLocking()
+
+

+          Enables the storage of all information that's needed to reopen this view at a
+ later point in time.
+
+
+
  String
 enableDurableLocking(boolean enable)
 
 

-          Enables or disables the storage of all information that's needed to reopen this
- view at a later point in time.
+          Deprecated. Use enableDurableLocking() instead or disableDurableLocking(boolean), respectively.
 
 
 
@@ -1237,12 +1255,10 @@ void unlockObjects()

enableDurableLocking

-String enableDurableLocking(boolean enable)
+@Deprecated +String enableDurableLocking(boolean enable)
-
Enables or disables the storage of all information that's needed to reopen this - view at a later point in time. This information includes the branch point, the user ID of - the session, whether it's a read-only view or a transaction and all the - locks that are acquired or will be acquired while durable locking is enabled. +
Deprecated. Use enableDurableLocking() instead or disableDurableLocking(boolean), respectively.

@@ -1250,15 +1266,52 @@ enableDurableLocking
Since:
4.0
+
+
+
+
+ +

+enableDurableLocking

+
+String enableDurableLocking()
+
+
Enables the storage of all information that's needed to reopen this view at a + later point in time. This information includes the branch point, the user ID of the + session, whether it's a read-only view or a transaction and all the locks + that are acquired or will be acquired while durable locking is enabled. +

+

+
+
+
+
Since:
+
4.1
See Also:
CDOViewContainer.openView(String), CDOViewContainer.openView(String, ResourceSet), CDOTransactionContainer.openTransaction(String), CDOTransactionContainer.openTransaction(String, ResourceSet), -lockObjects(Collection, IRWLockManager.LockType, long), -unlockObjects(Collection, IRWLockManager.LockType), -unlockObjects(), -CDOObject.cdoReadLock(), -CDOObject.cdoWriteLock()
+disableDurableLocking(boolean)
+ + +
+ +

+disableDurableLocking

+
+void disableDurableLocking(boolean releaseLocks)
+
+
Disables the storage of all information that's needed to reopen this view at a + later point in time. If such information is stored when this method is called it is removed. Note that locks + acquired by this view are only released if true is passed to the releaseLocks parameter. +

+

+
+
+
+
Since:
+
4.1
+
See Also:
enableDurableLocking()
diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.png b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.png index 0ba33a939e..4fbda61444 100644 Binary files a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.png and b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/CDOView.png differ diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/class-use/CDOView.Options.LoadNotificationEvent.html b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/class-use/CDOView.Options.LoadNotificationEvent.html new file mode 100644 index 0000000000..97379b3693 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/class-use/CDOView.Options.LoadNotificationEvent.html @@ -0,0 +1,143 @@ + + + + + + +Uses of Interface org.eclipse.emf.cdo.view.CDOView.Options.LoadNotificationEvent (CDO Model Repository Documentation) + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class   Use  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
org.eclipse.emf.cdo.view.CDOView.Options.LoadNotificationEvent

+
+No usage of org.eclipse.emf.cdo.view.CDOView.Options.LoadNotificationEvent +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class   Use  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) and others. + + diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/class-use/CDOView.html b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/class-use/CDOView.html index b357501672..7c4a968cf3 100644 --- a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/class-use/CDOView.html +++ b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/class-use/CDOView.html @@ -424,7 +424,7 @@ Uses of CDOEditorInput.getView()
-            +          Returns the CDOView associated with this CDOEditorInput diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/package-frame.html b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/package-frame.html index 00599bf450..2f35ffbced 100644 --- a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/package-frame.html +++ b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/package-frame.html @@ -54,6 +54,8 @@ Interfaces 
CDOView.Options.InvalidationPolicyEvent
+CDOView.Options.LoadNotificationEvent +
CDOView.Options.ReferencePolicyEvent
CDOView.Options.RevisionPrefetchingPolicyEvent diff --git a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/package-summary.html b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/package-summary.html index b03c09f409..9093a86fee 100644 --- a/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/package-summary.html +++ b/plugins/org.eclipse.emf.cdo.doc/javadoc/org/eclipse/emf/cdo/view/package-summary.html @@ -189,6 +189,11 @@ Client concepts for dealing with views, view sets, queries, CDO objects and EMF invalidation policy option has changed. +CDOView.Options.LoadNotificationEvent +An options event fired from view options when the + load notification enabled option has changed. + + CDOView.Options.ReferencePolicyEvent Deprecated. Use CDOView.Options.StrongReferencePolicyEvent instead. -- cgit v1.2.1