Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 55061200CFC for ; Thu, 27 Jul 2017 08:08:42 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 5389616A43F; Thu, 27 Jul 2017 06:08:42 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 74D3216A41C for ; Thu, 27 Jul 2017 08:08:39 +0200 (CEST) Received: (qmail 85907 invoked by uid 500); 27 Jul 2017 06:08:38 -0000 Mailing-List: contact commits-help@polygene.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@polygene.apache.org Delivered-To: mailing list commits@polygene.apache.org Received: (qmail 85276 invoked by uid 99); 27 Jul 2017 06:08:37 -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; Thu, 27 Jul 2017 06:08:37 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 43EF8F3301; Thu, 27 Jul 2017 06:08:35 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: paulmerlin@apache.org To: commits@polygene.apache.org Date: Thu, 27 Jul 2017 06:08:58 -0000 Message-Id: In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [24/51] [partial] polygene-website git commit: update website for 3.0.0 archived-at: Thu, 27 Jul 2017 06:08:42 -0000 http://git-wip-us.apache.org/repos/asf/polygene-website/blob/86741dec/content/java/3.0.0/javadocs/org/apache/polygene/api/cache/package-summary.html ---------------------------------------------------------------------- diff --git a/content/java/3.0.0/javadocs/org/apache/polygene/api/cache/package-summary.html b/content/java/3.0.0/javadocs/org/apache/polygene/api/cache/package-summary.html new file mode 100644 index 0000000..174fba0 --- /dev/null +++ b/content/java/3.0.0/javadocs/org/apache/polygene/api/cache/package-summary.html @@ -0,0 +1,170 @@ + + + + + + +org.apache.polygene.api.cache (Apache Polygene™ (Java Edition) SDK 3.0.0) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package org.apache.polygene.api.cache

+
+
Cache API.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    CacheOptions +
    CacheOptions is a metaInfo class for the Cache system for Entity persistence.
    +
    +
    • +
+ + + +

Package org.apache.polygene.api.cache Description

+

Cache API.

+

+ The Cache API/SPI is an extension point for Entity Store caching. +

+

+ The API part is only to allow caching options to be passed to the underlying extension in a uniform and + standard way. CacheOptions are to be passed as meta info on the optional Cache extension that is specified + during assembly phase. Example; +

+

+public void assemble( ModuleAssembly module )
+{
+    CacheOptions options = new CacheOptions( true, true, false );
+    module.addServices( EhCacheService.class ).setMetaInfo( options );
+}
+
+

+ Not all EntityStore implementations use the Cache extension, so check the implementation details of the + EntityStore whether the cache extension can bring any benefits or not. +

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + http://git-wip-us.apache.org/repos/asf/polygene-website/blob/86741dec/content/java/3.0.0/javadocs/org/apache/polygene/api/cache/package-tree.html ---------------------------------------------------------------------- diff --git a/content/java/3.0.0/javadocs/org/apache/polygene/api/cache/package-tree.html b/content/java/3.0.0/javadocs/org/apache/polygene/api/cache/package-tree.html new file mode 100644 index 0000000..97b98a5 --- /dev/null +++ b/content/java/3.0.0/javadocs/org/apache/polygene/api/cache/package-tree.html @@ -0,0 +1,135 @@ + + + + + + +org.apache.polygene.api.cache Class Hierarchy (Apache Polygene™ (Java Edition) SDK 3.0.0) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package org.apache.polygene.api.cache

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + http://git-wip-us.apache.org/repos/asf/polygene-website/blob/86741dec/content/java/3.0.0/javadocs/org/apache/polygene/api/common/AppliesTo.html ---------------------------------------------------------------------- diff --git a/content/java/3.0.0/javadocs/org/apache/polygene/api/common/AppliesTo.html b/content/java/3.0.0/javadocs/org/apache/polygene/api/common/AppliesTo.html new file mode 100644 index 0000000..f8d6ca2 --- /dev/null +++ b/content/java/3.0.0/javadocs/org/apache/polygene/api/common/AppliesTo.html @@ -0,0 +1,289 @@ + + + + + + +AppliesTo (Apache Polygene™ (Java Edition) SDK 3.0.0) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + +
+
org.apache.polygene.api.common
+

Annotation Type AppliesTo

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+ @Target(value={TYPE,METHOD})
+ @Documented
+public @interface AppliesTo
    +
    Fragments that implement InvocationHandler and which should only be applied to methods that have a particular + annotation or implement a known interface should use this annotation. +

    + @AppliesTo can specify one of; +

    +
      +
    • An annotation,
      • +
    • An interface,
      • +
    • An AppliesToFilter implementation.
      • +
    +

    + Example with annotation: +

    + 
    
+
+ @AppliesTo( Sessional.class )   // Tells Polygene to apply this concern on methods with @Sessional annotation
+ public class SessionConcern extends GenericConcern
+ {
+     public Object invoke( Object proxy, Method method, Object[] args )
+         throws Throwable
+     {
+         ... do session stuff ...
+     }
+ }
+
+ @Retention( RetentionPolicy.RUNTIME )
+ @Target( ElementType.METHOD )
+ @Documented
+ @Inherited
+ public @interface Sessional
+ {
+ }
+
+ public class MyMixin
+     implements My
+ {
+     @Sessional
+     public void doSomethingSessional()
+     {
+        // ... do your logic wrapped in a session
+     }
+
+     public void doSomethingWithoutSession()
+     {
+        // ... do stuff that are not wrapped in session.
+     }
+ }
+
+ public interface My
+ {
+     void doSomethingSessional();
+
+     void doSomethingWithoutSession();
+ }
+
+ @Concerns( SessionConcern.class )
+ @Mixins( MyMixin.class )
+ public interface MyComposite extends My, TransientComposite
+ {}
+
    +

    + The doSomethingWithoutSession method do not have the @Sessional annotation, therefore the SessionConcern will + not be placed into the call sequence of these methods, and + vice-versa. The @Sessional annotation can be placed either on the interface method or the implementation + method, depending on whether it is a contract or implementation detail. +

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

      Required Element Summary

      + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired Element and Description
      Class<?>[]value +
      List of interfaces, annotations or AppliesToFilter + implementation classes.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract Class<?>[] value
        +
        List of interfaces, annotations or AppliesToFilter + implementation classes. + If one of them matches the current element it will be + accepted, so this list can be considered an "or".
        +
        +
        Returns:
        +
        array of classes or interfaces to be used by the filter
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Field | 
    • +
  • Required | 
    • +
  • Optional
    • +
+ +
+ + +
+ + + http://git-wip-us.apache.org/repos/asf/polygene-website/blob/86741dec/content/java/3.0.0/javadocs/org/apache/polygene/api/common/AppliesToFilter.html ---------------------------------------------------------------------- diff --git a/content/java/3.0.0/javadocs/org/apache/polygene/api/common/AppliesToFilter.html b/content/java/3.0.0/javadocs/org/apache/polygene/api/common/AppliesToFilter.html new file mode 100644 index 0000000..94ee9e0 --- /dev/null +++ b/content/java/3.0.0/javadocs/org/apache/polygene/api/common/AppliesToFilter.html @@ -0,0 +1,318 @@ + + + + + + +AppliesToFilter (Apache Polygene™ (Java Edition) SDK 3.0.0) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.apache.polygene.api.common
+

Interface AppliesToFilter

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    DefaultMethodsFilter, ExcludeCompositeFilter, InteractionConstraintsConcern.HasInteractionConstraints, PropertyMixin.PropertyFilter
    +
    +
    +
    +
    public interface AppliesToFilter
    +
    Implementations of this interface can be specified in the @AppliesTo. +

    + AppliesTo filters are one of the driving technologies in Polygene. They allow you to apply fragments (Mixins, + Concerns, SideEffects), often generic ones, depending on the context that they are evaluated under. This + mechanism is heavily used internally in Polygene to achieve many other features. +

    +

    + The starting point is the basic use of AppliesToFilter, where the @AppliesTo annotation is given an + AppliesToFilter implementation as an argument, for instance at a Mixin implementation; +

    + 
    
+ @AppliesTo( MyAppliesToFilter.class )
+ public class SomeMixin
+     implements InvocationHandler
+ {
+
+ }
+
+ public class MyAppliesToFilter
+     implements AppliesToFilter
+ {
+     public boolean appliesTo( Method method, Class<?> mixin, Class<?> compositeType, Class<?> fragmentClass )
+     {
+         return method.getName().startsWith( "my" );
+     }
+ }
+
    +

    + In the case above, the generic mixin will only be applied to the methods that that is defined by the + AppliesToFilter. This is the primary way to define limits on the application of generic fragments, since + especially mixins are rarely applied to all methods. +

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

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static AppliesToFilterALWAYS +
      This is an internal AppliesToFilter which is assigned if no other AppliesToFilters are found for a given + fragment.
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        ALWAYS

        +
        static final AppliesToFilter ALWAYS
        +
        This is an internal AppliesToFilter which is assigned if no other AppliesToFilters are found for a given + fragment. +

        + There is no reason for user code to use this AppliesToFilter directly, and should be perceived as an + internal class in Polygene. +

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

      Method Detail

      + + + +
        +
      • +

        appliesTo

        +
        boolean appliesTo(Method method,
+                  Class<?> mixin,
+                  Class<?> compositeType,
+                  Class<?> fragmentClass)
        +
        Check if the Fragment should be applied or not. Will be call when applied to Mixins, Concerns, SideEffects.
        +
        +
        Parameters:
        +
        method - method that is invoked
        +
        mixin - mixin implementation for the method
        +
        compositeType - composite type
        +
        fragmentClass - fragment that is being applies
        +
        Returns:
        +
        true if the filter passes, otherwise false
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + http://git-wip-us.apache.org/repos/asf/polygene-website/blob/86741dec/content/java/3.0.0/javadocs/org/apache/polygene/api/common/ConstructionException.html ---------------------------------------------------------------------- diff --git a/content/java/3.0.0/javadocs/org/apache/polygene/api/common/ConstructionException.html b/content/java/3.0.0/javadocs/org/apache/polygene/api/common/ConstructionException.html new file mode 100644 index 0000000..216c155 --- /dev/null +++ b/content/java/3.0.0/javadocs/org/apache/polygene/api/common/ConstructionException.html @@ -0,0 +1,320 @@ + + + + + + +ConstructionException (Apache Polygene™ (Java Edition) SDK 3.0.0) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.polygene.api.common
+

Class ConstructionException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Direct Known Subclasses:
    +
    InvalidPropertyTypeException
    +
    +
    +
    +
    public class ConstructionException
+extends RuntimeException
    +
    Thrown when a Fragment or object could not be instantiated. + This includes, but not be limited to; +
      +
    • private constructor.
      • +
    • abstract class for Constraints.
      • +
    • interface instead of a class.
      • +
    • useful constructor missing.
      • +
    • exception thrown in the constructor.
      • +
    • Subclassing of org.apache.polygene.api.property.Property
      • +
    +

    + See the nested exception for additional details. +

    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConstructionException

        +
        public ConstructionException()
        +
        • +
      + + + +
        +
      • +

        ConstructionException

        +
        public ConstructionException(String message)
        +
        • +
      + + + +
        +
      • +

        ConstructionException

        +
        public ConstructionException(String message,
+                             Throwable cause)
        +
        • +
      + + + +
        +
      • +

        ConstructionException

        +
        public ConstructionException(Throwable cause)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + http://git-wip-us.apache.org/repos/asf/polygene-website/blob/86741dec/content/java/3.0.0/javadocs/org/apache/polygene/api/common/InvalidApplicationException.html ---------------------------------------------------------------------- diff --git a/content/java/3.0.0/javadocs/org/apache/polygene/api/common/InvalidApplicationException.html b/content/java/3.0.0/javadocs/org/apache/polygene/api/common/InvalidApplicationException.html new file mode 100644 index 0000000..00f969d --- /dev/null +++ b/content/java/3.0.0/javadocs/org/apache/polygene/api/common/InvalidApplicationException.html @@ -0,0 +1,286 @@ + + + + + + +InvalidApplicationException (Apache Polygene™ (Java Edition) SDK 3.0.0) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.polygene.api.common
+

Class InvalidApplicationException

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

      Constructor Detail

      + + + +
        +
      • +

        InvalidApplicationException

        +
        public InvalidApplicationException(String string)
        +
        • +
      + + + +
        +
      • +

        InvalidApplicationException

        +
        public InvalidApplicationException(String string,
+                                   Throwable cause)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +