[FOray-commit] SF.net SVN: foray: [7861] trunk/foray/foray-fotree/src/java/org/foray/ fotree/fo/obj

[<vic...@us...>]

Revision: 7861
          http://svn.sourceforge.net/foray/?rev=7861&view=rev
Author:   victormote
Date:     2006-09-02 16:40:57 -0700 (Sat, 02 Sep 2006)

Log Message:
-----------
1. Add some javadoc.
2. Move some property validation from startup() to validateProperties().

Modified Paths:
--------------
    trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/AbstractFlow.java
    trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/AbstractPageMaster.java
    trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/BasicLink.java
    trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Bookmark.java
    trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Character.java
    trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/ConditionalPageMasterReference.java
    trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Flow.java
    trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Leader.java
    trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Marker.java
    trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/PageSequence.java
    trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/PageSequenceMaster.java
    trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Region.java
    trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/RepeatablePMReference.java
    trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/SimplePageMaster.java
    trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/SinglePageMasterReference.java
    trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/StaticContent.java

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/AbstractFlow.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/AbstractFlow.java	2006-09-02 23:11:38 UTC (rev 7860)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/AbstractFlow.java	2006-09-02 23:40:57 UTC (rev 7861)
@@ -64,6 +64,9 @@
         return;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     protected void setup() throws FOTreeException {
         final String name = traitFlowName();
         if (name == null || name.equals("")) {

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/AbstractPageMaster.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/AbstractPageMaster.java	2006-09-02 23:11:38 UTC (rev 7860)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/AbstractPageMaster.java	2006-09-02 23:40:57 UTC (rev 7861)
@@ -54,7 +54,10 @@
      * {@inheritDoc}
      */
     protected void validateProperties() throws FOTreeException {
-        return;
+        if (traitMasterName() == null) {
+            logWarning(this.getFullName() + " has no "
+                    + "master-name, and will be ignored.");
+        }
     }
 
     /**

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/BasicLink.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/BasicLink.java	2006-09-02 23:11:38 UTC (rev 7860)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/BasicLink.java	2006-09-02 23:40:57 UTC (rev 7861)
@@ -41,6 +41,9 @@
         super(parent, propertyList, systemId, line, column);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public void setup() throws FOTreeException {
         if (! isValid()) {
             throwException(getFullName() + " must specify internal-destination "

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Bookmark.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Bookmark.java	2006-09-02 23:11:38 UTC (rev 7860)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Bookmark.java	2006-09-02 23:40:57 UTC (rev 7861)
@@ -70,6 +70,9 @@
         return;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public void setup() throws FOTreeException {
         final String _internalDestination = this.traitInternalDestination();
         if (_internalDestination == null || _internalDestination.equals("")) {

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Character.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Character.java	2006-09-02 23:11:38 UTC (rev 7860)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Character.java	2006-09-02 23:40:57 UTC (rev 7861)
@@ -77,6 +77,9 @@
         return true;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public void setup() throws FOTreeException {
         final char c = traitCharacter();
         if (c == org.foray.fotree.fo.prop.Character.CHARACTER_NOT_SPECIFIED) {

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/ConditionalPageMasterReference.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/ConditionalPageMasterReference.java	2006-09-02 23:11:38 UTC (rev 7860)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/ConditionalPageMasterReference.java	2006-09-02 23:40:57 UTC (rev 7861)
@@ -72,6 +72,9 @@
         return;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public void setup() {
         /* Validate properties. */
         if (traitMasterReference() == null) {

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Flow.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Flow.java	2006-09-02 23:11:38 UTC (rev 7860)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Flow.java	2006-09-02 23:40:57 UTC (rev 7861)
@@ -42,6 +42,9 @@
         super(parent, propertyList, systemId, line, column);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public void setup() throws FOTreeException {
         getPageSequence().addFlow(this);
     }

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Leader.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Leader.java	2006-09-02 23:11:38 UTC (rev 7860)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Leader.java	2006-09-02 23:40:57 UTC (rev 7861)
@@ -67,6 +67,9 @@
         return;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public void setup() throws FOTreeException {
         /* Using a null context here is OK, because we are not computing
          * a length to be used anywhere, only testing the relative values of

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Marker.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Marker.java	2006-09-02 23:11:38 UTC (rev 7860)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Marker.java	2006-09-02 23:40:57 UTC (rev 7861)
@@ -83,6 +83,9 @@
         return;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public void setup() throws FOTreeException {
         // Make sure that no sibling marker has the same 'marker-class-name'.
         final List siblings = realParent().getChildren();

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/PageSequence.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/PageSequence.java	2006-09-02 23:11:38 UTC (rev 7860)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/PageSequence.java	2006-09-02 23:40:57 UTC (rev 7861)
@@ -93,6 +93,9 @@
         return;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public void setup() throws FOTreeException {
         // get the 'format' properties
         this.pageNumberGenerator = new PageNumberGenerator(this.traitFormat(),

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/PageSequenceMaster.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/PageSequenceMaster.java	2006-09-02 23:11:38 UTC (rev 7860)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/PageSequenceMaster.java	2006-09-02 23:40:57 UTC (rev 7861)
@@ -78,6 +78,9 @@
         return;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public void setup() throws FOTreeException {
         currentSubSequenceNumber = -1;
         currentSubSequence = null;

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Region.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Region.java	2006-09-02 23:11:38 UTC (rev 7860)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/Region.java	2006-09-02 23:40:57 UTC (rev 7861)
@@ -65,6 +65,9 @@
         return;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public void setup() throws FOTreeException {
         if (traitRegionName() == null
                 || traitRegionName().equals("")) {

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/RepeatablePMReference.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/RepeatablePMReference.java	2006-09-02 23:11:38 UTC (rev 7860)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/RepeatablePMReference.java	2006-09-02 23:40:57 UTC (rev 7861)
@@ -75,6 +75,9 @@
         return;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public void setup() {
         /* Validate properites. */
         final String masterReference = traitMasterReference();

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/SimplePageMaster.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/SimplePageMaster.java	2006-09-02 23:11:38 UTC (rev 7860)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/SimplePageMaster.java	2006-09-02 23:40:57 UTC (rev 7861)
@@ -53,11 +53,11 @@
         super(parent, propertyList, systemId, line, column);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     protected void setup() throws FOTreeException {
-        if (traitMasterName() == null) {
-            logWarning("simple-page-master has no "
-                    + "master-name, and will be ignored.");
-        } else {
+        if (traitMasterName() != null) {
             getLayoutMasterSet().addSimplePageMaster(this);
         }
     }

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/SinglePageMasterReference.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/SinglePageMasterReference.java	2006-09-02 23:11:38 UTC (rev 7860)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/SinglePageMasterReference.java	2006-09-02 23:40:57 UTC (rev 7861)
@@ -63,7 +63,11 @@
      * {@inheritDoc}
      */
     protected void validateProperties() throws FOTreeException {
-        return;
+        final String masterReference = traitMasterReference();
+        if (masterReference.equals("")) {
+            this.logWarning(getFullName() + " has no master-reference, and "
+                    + "will be ignored.");
+        }
     }
 
     /**
@@ -73,12 +77,11 @@
         return;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public void setup() {
-        final String masterReference = traitMasterReference();
-        if (masterReference.equals("")) {
-            this.logWarning(getFullName() + " has no master-reference, and "
-                    + "will be ignored.");
-        }
+        return;
     }
 
     /**

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/StaticContent.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/StaticContent.java	2006-09-02 23:11:38 UTC (rev 7860)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/fo/obj/StaticContent.java	2006-09-02 23:40:57 UTC (rev 7861)
@@ -42,6 +42,9 @@
         super(parent, propertyList, systemId, line, column);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public void setup() throws FOTreeException {
         super.setup();
         getPageSequence().addStaticContent(this);


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.