Return-Path: X-Original-To: apmail-geode-commits-archive@minotaur.apache.org Delivered-To: apmail-geode-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id BA32B1820C for ; Fri, 22 Apr 2016 22:46:54 +0000 (UTC) Received: (qmail 8502 invoked by uid 500); 22 Apr 2016 22:46:54 -0000 Delivered-To: apmail-geode-commits-archive@geode.apache.org Received: (qmail 8474 invoked by uid 500); 22 Apr 2016 22:46:54 -0000 Mailing-List: contact commits-help@geode.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@geode.incubator.apache.org Delivered-To: mailing list commits@geode.incubator.apache.org Received: (qmail 8465 invoked by uid 99); 22 Apr 2016 22:46:54 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd1-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 22 Apr 2016 22:46:54 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd1-us-west.apache.org (ASF Mail Server at spamd1-us-west.apache.org) with ESMTP id 182B0C31A7 for ; Fri, 22 Apr 2016 22:46:54 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd1-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -3.016 X-Spam-Level: X-Spam-Status: No, score=-3.016 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_LAZY_DOMAIN_SECURITY=1, KAM_MANYCOMMENTS=1.2, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, RP_MATCHES_RCVD=-0.996] autolearn=disabled Received: from mx1-lw-us.apache.org ([10.40.0.8]) by localhost (spamd1-us-west.apache.org [10.40.0.7]) (amavisd-new, port 10024) with ESMTP id LRVzmrhwCd54 for ; Fri, 22 Apr 2016 22:46:50 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-lw-us.apache.org (ASF Mail Server at mx1-lw-us.apache.org) with SMTP id 88CD160F70 for ; Fri, 22 Apr 2016 22:46:44 +0000 (UTC) Received: (qmail 7589 invoked by uid 99); 22 Apr 2016 22:46:43 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 22 Apr 2016 22:46:43 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id D0F25E9E93; Fri, 22 Apr 2016 22:46:42 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: dbarnes@apache.org To: commits@geode.incubator.apache.org Date: Fri, 22 Apr 2016 22:46:52 -0000 Message-Id: <41c90d4254244f648fe6da069300af52@git.apache.org> In-Reply-To: <540609d930434691af7e4f7cfc810d8f@git.apache.org> References: <540609d930434691af7e4f7cfc810d8f@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [11/51] [partial] incubator-geode git commit: Adding javadocs for the M2 release, removed snapshot version http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/534f8357/releases/10M2/javadoc/com/gemstone/gemfire/cache/CustomEvictionAttributes.html ---------------------------------------------------------------------- diff --git a/releases/10M2/javadoc/com/gemstone/gemfire/cache/CustomEvictionAttributes.html b/releases/10M2/javadoc/com/gemstone/gemfire/cache/CustomEvictionAttributes.html new file mode 100644 index 0000000..90f0efe --- /dev/null +++ b/releases/10M2/javadoc/com/gemstone/gemfire/cache/CustomEvictionAttributes.html @@ -0,0 +1,345 @@ + + + + + +CustomEvictionAttributes (Apache Geode 1.0.0-incubating.M2) + + + + + + + + + + + + +
+
com.gemstone.gemfire.cache
+

Class CustomEvictionAttributes

+
+
+
    +
  • java.lang.Object
  • +
  • +
      +
    • com.gemstone.gemfire.cache.CustomEvictionAttributes
    • +
    +
  • +
+
+
    +
  • +
    +
    +
    public abstract class CustomEvictionAttributes
    +extends java.lang.Object
    +
    Custom eviction attributes including EvictionCriteria and evictor + start time and frequency, if any.
    +
    +
    Since:
    +
    gfxd 1.0
    +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected CustomEvictionAttributes(EvictionCriteria<?,?> criteria, + long startTime, + long interval, + boolean evictIncoming) 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      <K,V> EvictionCriteria<K,V>getCriteria() +
      Get the EvictionCriteria for this custom eviction.
      +
      longgetEvictorInterval() +
      The intervals at which the periodic evictor task is fired and + EvictionCriteria evaluated to evict entries.
      +
      longgetEvictorStartTime() +
      The absolute start time in milliseconds (as returned by + System.currentTimeMillis()) when the evictor will be first fired.
      +
      booleanisEvictIncoming() +
      If this returns true, then the criteria should always be applied to + incoming entries and never as a periodic task.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        CustomEvictionAttributes

        +
        protected CustomEvictionAttributes(EvictionCriteria<?,?> criteria,
        +                                   long startTime,
        +                                   long interval,
        +                                   boolean evictIncoming)
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getEvictorStartTime

        +
        public final long getEvictorStartTime()
        +
        The absolute start time in milliseconds (as returned by + System.currentTimeMillis()) when the evictor will be first fired. + Thereafter the evictor will be fired periodically every + getEvictorInterval() milliseconds.
        +
      • +
      + + + +
        +
      • +

        getEvictorInterval

        +
        public final long getEvictorInterval()
        +
        The intervals at which the periodic evictor task is fired and + EvictionCriteria evaluated to evict entries.
        +
      • +
      + + + +
        +
      • +

        isEvictIncoming

        +
        public final boolean isEvictIncoming()
        +
        If this returns true, then the criteria should always be applied to + incoming entries and never as a periodic task.
        +
      • +
      +
    • +
    +
  • +
+
+
+ + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/534f8357/releases/10M2/javadoc/com/gemstone/gemfire/cache/CustomExpiry.html ---------------------------------------------------------------------- diff --git a/releases/10M2/javadoc/com/gemstone/gemfire/cache/CustomExpiry.html b/releases/10M2/javadoc/com/gemstone/gemfire/cache/CustomExpiry.html new file mode 100644 index 0000000..5b639d9 --- /dev/null +++ b/releases/10M2/javadoc/com/gemstone/gemfire/cache/CustomExpiry.html @@ -0,0 +1,253 @@ + + + + + +CustomExpiry (Apache Geode 1.0.0-incubating.M2) + + + + + + + + + + + + +
+
com.gemstone.gemfire.cache
+

Interface CustomExpiry<K,V>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    CacheCallback
    +
    +
    +
    All Known Implementing Classes:
    +
    SessionCustomExpiry
    +
    +
    +
    +
    public interface CustomExpiry<K,V>
    +extends CacheCallback
    +
    This is the contract that a custom-expiry element must honor. + It determines the expiration characteristics for a specific entry in a region. +

    Note that if you wish to refer to an implementation of this interface in XML, + the implementation must also implement the Declarable interface.

    +
  • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getExpiry

        +
        ExpirationAttributes getExpiry(Region.Entry<K,V> entry)
        +
        Calculate the expiration for a given entry. + Returning null indicates that the + default for the region should be used. +

        + The entry parameter should not be used after this method invocation completes.

        +
        +
        Parameters:
        +
        entry - the entry to calculate the expiration for
        +
        Returns:
        +
        the expiration to be used, null if the region's defaults should be + used.
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/534f8357/releases/10M2/javadoc/com/gemstone/gemfire/cache/DataPolicy.html ---------------------------------------------------------------------- diff --git a/releases/10M2/javadoc/com/gemstone/gemfire/cache/DataPolicy.html b/releases/10M2/javadoc/com/gemstone/gemfire/cache/DataPolicy.html new file mode 100644 index 0000000..dcb85bf --- /dev/null +++ b/releases/10M2/javadoc/com/gemstone/gemfire/cache/DataPolicy.html @@ -0,0 +1,781 @@ + + + + + +DataPolicy (Apache Geode 1.0.0-incubating.M2) + + + + + + + + + + + + +
+
com.gemstone.gemfire.cache
+

Class DataPolicy

+
+
+
    +
  • java.lang.Object
  • +
  • +
      +
    • com.gemstone.gemfire.cache.DataPolicy
    • +
    +
  • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class DataPolicy
    +extends java.lang.Object
    +implements java.io.Serializable
    +
    Enumerated type for region data policy. + The data policy specifies how this local cache will handle the data for a region. +
      +
    1. EMPTY causes data to never be stored in local memory. The region will always appear empty. It can be used to for zero footprint producers that only want to distribute their data to others and for zero footprint consumers that only want to see events. +
    2. NORMAL causes data that this region is interested in to be stored in local memory. It allows the contents in this cache to differ from other caches. +
    3. PARTITION causes data that this region holds to be spread across processes. The amount of data held in this cache is configured in PartitionAttributes with a PartitionAttributesFactory. +
    4. PERSISTENT_PARTITION in addition to PARTITION also causes data to be stored to disk. The region initialization uses the data stored on disk. +
    5. REPLICATE causes data that this region is interested in to be stored in local memory. A distributed region will be initialized with the data from other caches. On distributed region operations that would cause the contents to differ with other caches are not allowed. This policy is allowed on local scope region but it behaves the same as NORMAL. +
    6. PERSISTENT_REPLICATE in addition to REPLICATE also causes data to be stored to disk. The region initialization uses the data stored on disk. Note that the persistence applies to both local scope and distributed scope. +
    7. HDFS_PARTITION in addition to PARTITION also causes data to be stored to HDFS. The region initialization may use the data stored on HDFS. +
    +
    +
    Since:
    +
    5.0
    +
    See Also:
    +
    AttributesFactory.setDataPolicy(com.gemstone.gemfire.cache.DataPolicy), +RegionAttributes.getDataPolicy(), +Serialized Form
    +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static DataPolicyDEFAULT +
      The data policy used by default; it is NORMAL.
      +
      static DataPolicyEMPTY +
      Data is never stored in local memory.
      +
      static DataPolicyNORMAL +
      Allows the contents in this cache to differ from other caches.
      +
      byteordinal +
      used as ordinal to represent this DataPolicy
      +
      static DataPolicyPARTITION +
      Data in this region may be spread across a number of processes.
      +
      static DataPolicyPERSISTENT_PARTITION +
      In addition to PARTITION also causes data to be stored to + disk.
      +
      static DataPolicyPERSISTENT_REPLICATE +
      In addition to REPLICATE also causes data to be stored to + disk.
      +
      static DataPolicyPRELOADED +
      In addition to NORMAL, contents inside of this cache are + (partially) initialized with data from other caches, if available.
      +
      static DataPolicyREPLICATE +
      The region will be initialized with the data from other caches and accepts + any new entries created in other caches.
      +
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      static DataPolicyfromOrdinal(byte ordinal) +
      Return the DataPolicy represented by specified ordinal
      +
      booleanisDefault() +
      Deprecated.  +
      from version 6.5 forward please use an identity comparison instead of this method
      +
      +
      booleanisEmpty() +
      Deprecated.  +
      from version 6.5 forward please use withStorage()
      +
      +
      booleanisNormal() +
      Deprecated.  +
      from version 6.5 forward please use an identity comparison instead of this method
      +
      +
      booleanisPartition() +
      Deprecated.  +
      from version 6.5 forward please use withPartitioning()
      +
      +
      booleanisPersistentReplicate() +
      Deprecated.  +
      from version 6.5 forward please use withPersistence() and withReplication()
      +
      +
      booleanisPreloaded() +
      Deprecated.  +
      from version 6.5 forward please use withPreloaded()
      +
      +
      booleanisReplicate() +
      Deprecated.  +
      from version 6.5 forward please use withReplication()
      +
      +
      java.lang.StringtoString() +
      Returns a string representation for this data policy.
      +
      booleanwithHDFS() +
      Return whether this policy does persistence on HDFS.
      +
      booleanwithPartitioning() +
      Return whether this policy does partitioning.
      +
      booleanwithPersistence() +
      Return whether this policy does persistence.
      +
      booleanwithPreloaded() +
      Return whether this policy does preloaded.
      +
      booleanwithReplication() +
      Return whether this policy does replication.
      +
      booleanwithStorage() +
      Return true if regions with this policy store data locally.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        EMPTY

        +
        public static final DataPolicy EMPTY
        +
        Data is never stored in local memory. + The region will always be empty locally. + It can be used to for zero footprint producers that only want to distribute + their data to others + and for zero footprint consumers that only want to see events.
        +
      • +
      + + + +
        +
      • +

        NORMAL

        +
        public static final DataPolicy NORMAL
        +
        Allows the contents in this cache to differ from other caches.

        + Data that this region is interested in is stored in local memory.

        +
      • +
      + + + +
        +
      • +

        REPLICATE

        +
        public static final DataPolicy REPLICATE
        +
        The region will be initialized with the data from other caches and accepts + any new entries created in other caches.

        + Operations that would cause the contents to differ with other caches + are not allowed.

        + Data that this region is interested in is stored in local memory.

        +
      • +
      + + + +
        +
      • +

        PERSISTENT_REPLICATE

        +
        public static final DataPolicy PERSISTENT_REPLICATE
        +
        In addition to REPLICATE also causes data to be stored to + disk. The region initialization may use the data stored on disk.
        +
      • +
      + + + +
        +
      • +

        PARTITION

        +
        public static final DataPolicy PARTITION
        +
        Data in this region may be spread across a number of processes. This is + further configured with partitioning attributes
        +
      • +
      + + + +
        +
      • +

        PRELOADED

        +
        public static final DataPolicy PRELOADED
        +
        In addition to NORMAL, contents inside of this cache are + (partially) initialized with data from other caches, if available.
        +
      • +
      + + + +
        +
      • +

        PERSISTENT_PARTITION

        +
        public static final DataPolicy PERSISTENT_PARTITION
        +
        In addition to PARTITION also causes data to be stored to + disk. The region initialization may use the data stored on disk.
        +
        +
        Since:
        +
        6.5
        +
        +
      • +
      + + + +
        +
      • +

        DEFAULT

        +
        public static final DataPolicy DEFAULT
        +
        The data policy used by default; it is NORMAL.
        +
      • +
      + + + +
        +
      • +

        ordinal

        +
        public final byte ordinal
        +
        used as ordinal to represent this DataPolicy
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        fromOrdinal

        +
        public static DataPolicy fromOrdinal(byte ordinal)
        +
        Return the DataPolicy represented by specified ordinal
        +
      • +
      + + + + + + + +
        +
      • +

        withReplication

        +
        public boolean withReplication()
        +
        Return whether this policy does replication.
        +
        +
        Returns:
        +
        true if this policy does replication.
        +
        See Also:
        +
        REPLICATE, +PERSISTENT_REPLICATE
        +
        +
      • +
      + + + +
        +
      • +

        withPersistence

        +
        public boolean withPersistence()
        +
        Return whether this policy does persistence.
        +
        +
        Returns:
        +
        true if this policy does persistence.
        +
        Since:
        +
        6.5
        +
        See Also:
        +
        PERSISTENT_PARTITION, +PERSISTENT_REPLICATE
        +
        +
      • +
      + + + +
        +
      • +

        withPartitioning

        +
        public boolean withPartitioning()
        +
        Return whether this policy does partitioning.
        +
        +
        Returns:
        +
        true if this policy does partitioning
        +
        Since:
        +
        6.5
        +
        See Also:
        +
        PARTITION, +PERSISTENT_PARTITION
        +
        +
      • +
      + + + +
        +
      • +

        withPreloaded

        +
        public boolean withPreloaded()
        +
        Return whether this policy does preloaded.
        +
        +
        Returns:
        +
        true if this policy does preloaded.
        +
        Since:
        +
        6.5
        +
        See Also:
        +
        PRELOADED
        +
        +
      • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Deprecated. from version 6.5 forward please use withStorage()
        +
        Return true if this policy is EMPTY.
        +
        +
        Returns:
        +
        true if this policy is EMPTY.
        +
        +
      • +
      + + + +
        +
      • +

        isNormal

        +
        public boolean isNormal()
        +
        Deprecated. from version 6.5 forward please use an identity comparison instead of this method
        +
        Return true if this policy is NORMAL.
        +
        +
        Returns:
        +
        true if this policy is NORMAL.
        +
        +
      • +
      + + + +
        +
      • +

        isPreloaded

        +
        public boolean isPreloaded()
        +
        Deprecated. from version 6.5 forward please use withPreloaded()
        +
        Return true if this policy is PRELOADED.
        +
        +
        Returns:
        +
        true if this policy is PRELOADED
        +
        +
      • +
      + + + +
        +
      • +

        isDefault

        +
        public boolean isDefault()
        +
        Deprecated. from version 6.5 forward please use an identity comparison instead of this method
        +
        Return true if this policy is the default.
        +
        +
        Returns:
        +
        true if this policy is the default.
        +
        +
      • +
      + + + +
        +
      • +

        isReplicate

        +
        public boolean isReplicate()
        +
        Deprecated. from version 6.5 forward please use withReplication()
        +
        Return true if this policy is REPLICATE.
        +
        +
        Returns:
        +
        true if this policy is REPLICATE.
        +
        +
      • +
      + + + +
        +
      • +

        isPersistentReplicate

        +
        public boolean isPersistentReplicate()
        +
        Deprecated. from version 6.5 forward please use withPersistence() and withReplication()
        +
        Return true if this policy is PERSISTENT_REPLICATE.
        +
        +
        Returns:
        +
        true if this policy is PERSISTENT_REPLICATE.
        +
        +
      • +
      + + + +
        +
      • +

        isPartition

        +
        public boolean isPartition()
        +
        Deprecated. from version 6.5 forward please use withPartitioning()
        +
        Return true if this policy is PARTITION.
        +
        +
        Returns:
        +
        true if this policy is PARTITION
        +
        +
      • +
      + + + +
        +
      • +

        withHDFS

        +
        public boolean withHDFS()
        +
        Return whether this policy does persistence on HDFS.
        +
        +
        Returns:
        +
        true if this policy does persistence on HDFS.
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Returns a string representation for this data policy.
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        Returns:
        +
        the name of this data policy.
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/534f8357/releases/10M2/javadoc/com/gemstone/gemfire/cache/Declarable.html ---------------------------------------------------------------------- diff --git a/releases/10M2/javadoc/com/gemstone/gemfire/cache/Declarable.html b/releases/10M2/javadoc/com/gemstone/gemfire/cache/Declarable.html new file mode 100644 index 0000000..fe174ba --- /dev/null +++ b/releases/10M2/javadoc/com/gemstone/gemfire/cache/Declarable.html @@ -0,0 +1,273 @@ + + + + + +Declarable (Apache Geode 1.0.0-incubating.M2) + + + + + + + + + + + + +
+
com.gemstone.gemfire.cache
+

Interface Declarable

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      voidinit(java.util.Properties props) +
      Initializes a user-defined object using the given properties.
      +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        init

        +
        void init(java.util.Properties props)
        +
        Initializes a user-defined object using the given properties. + Note that any uncaught exception thrown by this method will cause + the Cache initialization to fail.
        +
        +
        Parameters:
        +
        props - Contains the parameters declared in the declarative xml + file.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If one of the configuration options in props + is illegal or malformed.
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + + + + + +