3948913bfc
has been done in the NaturalDocs branch back to trunk. Thanks to everyone who helped out in making this happen. (I could list people, but the list would be long, and I'm already mentally on vacation.) git-svn-id: http://svn.openlayers.org/trunk/openlayers@3545 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
66 lines
1.6 KiB
JavaScript
66 lines
1.6 KiB
JavaScript
/* Copyright (c) 2006 MetaCarta, Inc., published under a modified BSD license.
|
|
* See http://svn.openlayers.org/trunk/openlayers/repository-license.txt
|
|
* for the full text of the license. */
|
|
|
|
/**
|
|
* @requires OpenLayers/Util.js
|
|
*
|
|
* Class: OpenLayers.Format
|
|
* Base class for format reading/writing a variety of formats. Subclasses
|
|
* of OpenLayers.Format are expected to have read and write methods.
|
|
*/
|
|
OpenLayers.Format = OpenLayers.Class.create();
|
|
OpenLayers.Format.prototype = {
|
|
|
|
/**
|
|
* Constructor: OpenLayers.Format
|
|
* Instances of this class are not useful. See one of the subclasses.
|
|
*
|
|
* Parameters:
|
|
* options - {Object} An optional object with properties to set on the
|
|
* format
|
|
*
|
|
* Return:
|
|
* An instance of OpenLayers.Format
|
|
*/
|
|
initialize: function(options) {
|
|
OpenLayers.Util.extend(this, options);
|
|
},
|
|
|
|
/**
|
|
* Method: read
|
|
* Read data from a string, and return an object whose type depends on the
|
|
* subclass.
|
|
*
|
|
* Parameters:
|
|
* data - {string} Data to read/parse.
|
|
*
|
|
* Return:
|
|
* Depends on the subclass
|
|
*/
|
|
read: function(data) {
|
|
alert("Read not implemented.");
|
|
},
|
|
|
|
/**
|
|
* Method: write
|
|
* Accept an object, and return a string.
|
|
*
|
|
* Parameters:
|
|
* object - {Object} Object to be serialized
|
|
*
|
|
* Return:
|
|
* {String} A string representation of the object.
|
|
*/
|
|
write: function(object) {
|
|
alert("Write not implemented.");
|
|
},
|
|
|
|
/**
|
|
* Constant: CLASS_NAME
|
|
* {String} OpenLayers.Format
|
|
*/
|
|
CLASS_NAME: "OpenLayers.Format"
|
|
|
|
};
|