svn commit: r653048 - /xmlgraphics/fop/trunk/src/java/org/apache/fop/layoutmgr/AbstractBaseLayoutManager.java

[adelmelle]

Author: adelmelle
Date: Sat May  3 03:55:07 2008
New Revision: 653048

URL: http://svn.apache.org/viewvc?rev=653048&view=rev
Log:
Tweaks: make fobj member final; have default implementations for some methods 
throw an UnsupportedOperationException instead of merely logging an error

Modified:
    
xmlgraphics/fop/trunk/src/java/org/apache/fop/layoutmgr/AbstractBaseLayoutManager.java

Modified: 
xmlgraphics/fop/trunk/src/java/org/apache/fop/layoutmgr/AbstractBaseLayoutManager.java
URL: 
http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/layoutmgr/AbstractBaseLayoutManager.java?rev=653048&r1=653047&r2=653048&view=diff
==============================================================================
--- 
xmlgraphics/fop/trunk/src/java/org/apache/fop/layoutmgr/AbstractBaseLayoutManager.java
 (original)
+++ 
xmlgraphics/fop/trunk/src/java/org/apache/fop/layoutmgr/AbstractBaseLayoutManager.java
 Sat May  3 03:55:07 2008
@@ -29,7 +29,7 @@
  * The base class for nearly all LayoutManagers.
  * Provides the functionality for merging the [EMAIL PROTECTED] LayoutManager}
  * and the [EMAIL PROTECTED] org.apache.fop.datatypes.PercentBaseContext} 
interfaces
- * into a common base calls for all higher LayoutManagers.
+ * into a common base class for all higher LayoutManagers.
  */
 public abstract class AbstractBaseLayoutManager 
     implements LayoutManager, PercentBaseContext {
@@ -39,7 +39,7 @@
     /** Indicator if this LM generates block areas */
     protected boolean generatesBlockArea = false;
     /** The formatting object for this LM */
-    protected FObj fobj = null;
+    protected final FObj fobj;
 
     /**
      * logging instance
@@ -50,6 +50,7 @@
      * Abstract base layout manager.
      */
     public AbstractBaseLayoutManager() {
+        fobj = null;
     }
 
     /**
@@ -67,9 +68,7 @@
 
     // --------- Property Resolution related functions --------- //
     
-    /**
-     * [EMAIL PROTECTED] 
-     */
+    /** [EMAIL PROTECTED] */
     public int getBaseLength(int lengthBase, FObj fobj) {
         if (fobj == this.fobj) {
             switch (lengthBase) {
@@ -82,7 +81,7 @@
             case LengthBase.CONTAINING_REFAREA_WIDTH:
                 return getReferenceAreaIPD();
             default:
-                log.error(new Exception("Unknown base type for LengthBase:" + 
lengthBase));
+                log.error("Unknown base type for LengthBase:" + lengthBase);
                 return 0;
             }
         } else {
@@ -112,9 +111,7 @@
             }
             lm = lm.getParent();
         }
-        if (lm == null) {
-            log.error("No parent LM found");
-        }
+        log.error("No parent LM found");
         return 0;
     }
 
@@ -131,9 +128,7 @@
             }
             lm = lm.getParent();
         }
-        if (lm == null) {
-            log.error("No parent LM found");
-        }
+        log.error("No parent LM found");
         return 0;
     }
 
@@ -176,9 +171,7 @@
             }
             lm = lm.getParent();
         }
-        if (lm == null) {
-            log.error("No parent LM found");
-        }
+        log.error("No parent LM found");
         return 0;
     }
 
@@ -195,31 +188,31 @@
             }
             lm = lm.getParent();
         }
-        if (lm == null) {
-            log.error("No parent LM found");
-        }
+        log.error("No parent LM found");
         return 0;
     }
 
     /**
      * [EMAIL PROTECTED]
+     * <i>NOTE: Should be overridden by subclasses.
+     * Default implementation throws an 
<code>UnsupportedOperationException</code>.</i>
      */
     public int getContentAreaIPD() {
-        log.error("getContentAreaIPD called when it should have been 
overwritten");
-        return 0;
+        throw new UnsupportedOperationException(
+                "getContentAreaIPD() called when it should have been 
overridden");
     }
    
     /**
      * [EMAIL PROTECTED]
+     * <i>NOTE: Should be overridden by subclasses.
+     * Default implementation throws an 
<code>UnsupportedOperationException</code>.</i>
      */
     public int getContentAreaBPD() {
-        log.error("getContentAreaBPD called when it should have been 
overwritten");
-        return 0;
+        throw new UnsupportedOperationException(
+                "getContentAreaBPD() called when it should have been 
overridden");
     }
     
-    /**
-     * [EMAIL PROTECTED]
-     */
+    /** [EMAIL PROTECTED] */
     public boolean getGeneratesReferenceArea() {
         return generatesReferenceArea;
     }
@@ -234,9 +227,7 @@
         this.generatesReferenceArea = generatesReferenceArea;
     }
    
-    /**
-     * [EMAIL PROTECTED]
-     */
+    /** [EMAIL PROTECTED] */
     public boolean getGeneratesBlockArea() {
         return generatesBlockArea;
     }
@@ -250,9 +241,7 @@
         this.generatesBlockArea = generatesBlockArea;
     }
    
-    /**
-     * [EMAIL PROTECTED]
-     */
+    /** [EMAIL PROTECTED] */
     public boolean getGeneratesLineArea() {
         return false;
     }



---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]