Implement RFE 449.

Provide a mechanism for developers to have complete control over how
their subclasses of Java 3D SceneGraphObjects are saved and loaded.

Issue number:
Obtained from:
Submitted by:
Reviewed by:


git-svn-id: https://svn.java.net/svn/j3d-core-utils~svn/trunk@153 9497e636-51bd-65ba-982d-a4982e1767a5

2 files changed, 71 insertions, 1 deletions

diff --git a/src/classes/share/com/sun/j3d/utils/scenegraph/io/SceneGraphStateProvider.java b/src/classes/share/com/sun/j3d/utils/scenegraph/io/SceneGraphStateProvider.java
new file mode 100644
index 0000000..f694005
--- /dev/null
+++ b/src/classes/share/com/sun/j3d/utils/scenegraph/io/SceneGraphStateProvider.java
@@ -0,0 +1,65 @@
+/*
+ * $RCSfile$
+ *
+ * Copyright (c) 2007 Sun Microsystems, Inc. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * - Redistribution of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * - Redistribution in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in
+ *   the documentation and/or other materials provided with the
+ *   distribution.
+ *
+ * Neither the name of Sun Microsystems, Inc. or the names of
+ * contributors may be used to endorse or promote products derived
+ * from this software without specific prior written permission.
+ *
+ * This software is provided "AS IS," without a warranty of any
+ * kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND
+ * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY
+ * EXCLUDED. SUN MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL
+ * NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF
+ * USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
+ * DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR
+ * ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL,
+ * CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND
+ * REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR
+ * INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGES.
+ *
+ * You acknowledge that this software is not designed, licensed or
+ * intended for use in the design, construction, operation or
+ * maintenance of any nuclear facility.
+ *
+ * $Revision$
+ * $Date$
+ * $State$
+ */
+
+package com.sun.j3d.utils.scenegraph.io;
+
+import com.sun.j3d.utils.scenegraph.io.state.javax.media.j3d.SceneGraphObjectState;
+
+/**
+ * This interface allows developers to provide their own custom IO control for
+ * subclasses of SceneGraphObjects. As the Scene Graph is being saved any 
+ * SceneGraphObject in the graph that implements this interface must provide 
+ * it's state class which is responsible for saving the entire state of 
+ * that object.
+ */
+public interface SceneGraphStateProvider {
+    
+    /**
+     * Returns the State class 
+     *
+     * @return Class that will perform the IO for the SceneGraphObject
+     */
+    public Class<? extends SceneGraphObjectState> getStateClass();
+    
+}
diff --git a/src/classes/share/com/sun/j3d/utils/scenegraph/io/retained/Controller.java b/src/classes/share/com/sun/j3d/utils/scenegraph/io/retained/Controller.java
index 736490c..38b6204 100644
--- a/src/classes/share/com/sun/j3d/utils/scenegraph/io/retained/Controller.java
+++ b/src/classes/share/com/sun/j3d/utils/scenegraph/io/retained/Controller.java
@@ -44,6 +44,7 @@
 
 package com.sun.j3d.utils.scenegraph.io.retained;
 
+import com.sun.j3d.utils.scenegraph.io.SceneGraphStateProvider;
 import java.lang.reflect.Constructor;
 import java.lang.reflect.InvocationTargetException;
 import java.io.DataOutput;
@@ -213,7 +214,11 @@ public abstract class Controller extends java.lang.Object {
         SceneGraphObjectState ret;
         
           try {
-              Class state = Class.forName( "com.sun.j3d.utils.scenegraph.io.state."+name+"State" );
+              Class state;
+              if (obj instanceof SceneGraphStateProvider)
+                  state = ((SceneGraphStateProvider)obj).getStateClass();
+              else 
+                  state = Class.forName( "com.sun.j3d.utils.scenegraph.io.state."+name+"State" );
               ret = constructStateObj( symbol, state, obj.getClass() );
           } catch(ClassNotFoundException e) {
               ret = checkSuperClasses( symbol );