[infinispan-commits] Infinispan SVN: r495 - trunk/core/src/main/java/org/infinispan/config.

infinispan-commits at lists.jboss.org infinispan-commits at lists.jboss.org
Tue Jun 23 09:40:14 EDT 2009


Author: vblagojevic at jboss.com
Date: 2009-06-23 09:40:14 -0400 (Tue, 23 Jun 2009)
New Revision: 495

Added:
   trunk/core/src/main/java/org/infinispan/config/ConfigurationAttribute.java
   trunk/core/src/main/java/org/infinispan/config/ConfigurationElement.java
   trunk/core/src/main/java/org/infinispan/config/ConfigurationElements.java
   trunk/core/src/main/java/org/infinispan/config/ConfigurationProperties.java
   trunk/core/src/main/java/org/infinispan/config/ConfigurationProperty.java
Log:
[ISPN-89] - Document all configuration options available in XML

Added: trunk/core/src/main/java/org/infinispan/config/ConfigurationAttribute.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/config/ConfigurationAttribute.java	                        (rev 0)
+++ trunk/core/src/main/java/org/infinispan/config/ConfigurationAttribute.java	2009-06-23 13:40:14 UTC (rev 495)
@@ -0,0 +1,47 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ * Copyright 2009, Red Hat Middleware LLC, and individual contributors
+ * as indicated by the @author tags. See the copyright.txt file in the
+ * distribution for a full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+package org.infinispan.config;
+
+import java.lang.annotation.*;
+
+/**
+ *  Represents an attribute of any XML element from a valid Infinispan configuration file. 
+ * 
+ * @author Vladimir Blagojevic
+ * @version $Id: ConfigurationAttribute.java,v 1.5 2008/05/23 11:11:02 belaban Exp $
+ */
+
+ at Retention(RetentionPolicy.RUNTIME)
+ at Target( { ElementType.METHOD })
+public @interface ConfigurationAttribute {
+
+   String containingElement();
+
+   String name();
+
+   String allowedValues() default "";
+
+   String defaultValue() default "";
+
+   String description() default "";
+
+}

Added: trunk/core/src/main/java/org/infinispan/config/ConfigurationElement.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/config/ConfigurationElement.java	                        (rev 0)
+++ trunk/core/src/main/java/org/infinispan/config/ConfigurationElement.java	2009-06-23 13:40:14 UTC (rev 495)
@@ -0,0 +1,44 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ * Copyright 2009, Red Hat Middleware LLC, and individual contributors
+ * as indicated by the @author tags. See the copyright.txt file in the
+ * distribution for a full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+package org.infinispan.config;
+
+import java.lang.annotation.*;
+
+
+/**
+ * Represents XML element from a valid Infinispan configuration file. 
+ * 
+ * @author Vladimir Blagojevic
+ * @version $Id: ConfigurationElement.java,v 1.5 2008/05/23 11:11:02 belaban Exp $
+ */
+
+ at Retention(RetentionPolicy.RUNTIME)
+ at Target( { ElementType.TYPE})
+public @interface ConfigurationElement {
+   
+    String name();
+
+    String parent();
+
+    String description() default "";
+      
+}

Added: trunk/core/src/main/java/org/infinispan/config/ConfigurationElements.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/config/ConfigurationElements.java	                        (rev 0)
+++ trunk/core/src/main/java/org/infinispan/config/ConfigurationElements.java	2009-06-23 13:40:14 UTC (rev 495)
@@ -0,0 +1,39 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ * Copyright 2009, Red Hat Middleware LLC, and individual contributors
+ * as indicated by the @author tags. See the copyright.txt file in the
+ * distribution for a full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+package org.infinispan.config;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Represents a list of XML elements from a valid Infinispan configuration file. 
+ * 
+ * @author Vladimir Blagojevic
+ * @version $Id: ConfigurationElements.java,v 1.5 2008/05/23 11:11:02 belaban Exp $
+ */
+ at Retention(RetentionPolicy.RUNTIME)
+ at Target( { ElementType.TYPE})
+public @interface ConfigurationElements {
+   ConfigurationElement [] elements();
+}

Added: trunk/core/src/main/java/org/infinispan/config/ConfigurationProperties.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/config/ConfigurationProperties.java	                        (rev 0)
+++ trunk/core/src/main/java/org/infinispan/config/ConfigurationProperties.java	2009-06-23 13:40:14 UTC (rev 495)
@@ -0,0 +1,39 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ * Copyright 2009, Red Hat Middleware LLC, and individual contributors
+ * as indicated by the @author tags. See the copyright.txt file in the
+ * distribution for a full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+package org.infinispan.config;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Represents a list of XML property elements from a valid Infinispan configuration file. 
+ * 
+ * @author Vladimir Blagojevic
+ * @version $Id: ConfigurationProperties.java,v 1.5 2008/05/23 11:11:02 belaban Exp $
+ */
+ at Retention(RetentionPolicy.RUNTIME)
+ at Target( { ElementType.METHOD })
+public @interface ConfigurationProperties {
+   ConfigurationProperty[] elements();
+}

Added: trunk/core/src/main/java/org/infinispan/config/ConfigurationProperty.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/config/ConfigurationProperty.java	                        (rev 0)
+++ trunk/core/src/main/java/org/infinispan/config/ConfigurationProperty.java	2009-06-23 13:40:14 UTC (rev 495)
@@ -0,0 +1,41 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ * Copyright 2009, Red Hat Middleware LLC, and individual contributors
+ * as indicated by the @author tags. See the copyright.txt file in the
+ * distribution for a full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+package org.infinispan.config;
+
+import java.lang.annotation.*;
+
+/**
+ * Represents a property element from a valid Infinispan configuration file. 
+ * 
+ * @author Vladimir Blagojevic
+ * @version $Id: ConfigurationProperty.java,v 1.5 2008/05/23 11:11:02 belaban Exp $
+ */
+ at Retention(RetentionPolicy.RUNTIME)
+ at Target( { ElementType.METHOD, ElementType.FIELD })
+public @interface ConfigurationProperty {
+
+   String parentElement();
+
+   String name();
+
+   String description() default "";
+}




More information about the infinispan-commits mailing list