| 1 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|---|
| 2 | /* ***** BEGIN LICENSE BLOCK *****
|
|---|
| 3 | * Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|---|
| 4 | *
|
|---|
| 5 | * The contents of this file are subject to the Mozilla Public License Version
|
|---|
| 6 | * 1.1 (the "License"); you may not use this file except in compliance with
|
|---|
| 7 | * the License. You may obtain a copy of the License at
|
|---|
| 8 | * http://www.mozilla.org/MPL/
|
|---|
| 9 | *
|
|---|
| 10 | * Software distributed under the License is distributed on an "AS IS" basis,
|
|---|
| 11 | * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|---|
| 12 | * for the specific language governing rights and limitations under the
|
|---|
| 13 | * License.
|
|---|
| 14 | *
|
|---|
| 15 | * The Original Code is Mozilla FastLoad code.
|
|---|
| 16 | *
|
|---|
| 17 | * The Initial Developer of the Original Code is
|
|---|
| 18 | * Netscape Communications Corporation.
|
|---|
| 19 | * Portions created by the Initial Developer are Copyright (C) 2001
|
|---|
| 20 | * the Initial Developer. All Rights Reserved.
|
|---|
| 21 | *
|
|---|
| 22 | * Contributor(s):
|
|---|
| 23 | * Brendan Eich <[email protected]> (original author)
|
|---|
| 24 | *
|
|---|
| 25 | * Alternatively, the contents of this file may be used under the terms of
|
|---|
| 26 | * either of the GNU General Public License Version 2 or later (the "GPL"),
|
|---|
| 27 | * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|---|
| 28 | * in which case the provisions of the GPL or the LGPL are applicable instead
|
|---|
| 29 | * of those above. If you wish to allow use of your version of this file only
|
|---|
| 30 | * under the terms of either the GPL or the LGPL, and not to allow others to
|
|---|
| 31 | * use your version of this file under the terms of the MPL, indicate your
|
|---|
| 32 | * decision by deleting the provisions above and replace them with the notice
|
|---|
| 33 | * and other provisions required by the GPL or the LGPL. If you do not delete
|
|---|
| 34 | * the provisions above, a recipient may use your version of this file under
|
|---|
| 35 | * the terms of any one of the MPL, the GPL or the LGPL.
|
|---|
| 36 | *
|
|---|
| 37 | * ***** END LICENSE BLOCK ***** */
|
|---|
| 38 |
|
|---|
| 39 | #include "nsISupports.idl"
|
|---|
| 40 |
|
|---|
| 41 | interface nsIObjectInputStream;
|
|---|
| 42 | interface nsIObjectOutputStream;
|
|---|
| 43 |
|
|---|
| 44 | [scriptable, uuid(91cca981-c26d-44a8-bebe-d9ed4891503a)]
|
|---|
| 45 | interface nsISerializable : nsISupports
|
|---|
| 46 | {
|
|---|
| 47 | /**
|
|---|
| 48 | * Initialize the object implementing nsISerializable, which must have
|
|---|
| 49 | * been freshly constructed via CreateInstance. All data members that
|
|---|
| 50 | * can't be set to default values must have been serialized by write,
|
|---|
| 51 | * and should be read from aInputStream in the same order by this method.
|
|---|
| 52 | */
|
|---|
| 53 | void read(in nsIObjectInputStream aInputStream);
|
|---|
| 54 |
|
|---|
| 55 | /**
|
|---|
| 56 | * Serialize the object implementing nsISerializable to aOutputStream, by
|
|---|
| 57 | * writing each data member that must be recovered later to reconstitute
|
|---|
| 58 | * a working replica of this object, in a canonical member and byte order,
|
|---|
| 59 | * to aOutputStream.
|
|---|
| 60 | *
|
|---|
| 61 | * NB: a class that implements nsISerializable *must* also implement
|
|---|
| 62 | * nsIClassInfo, in particular nsIClassInfo::GetClassID.
|
|---|
| 63 | */
|
|---|
| 64 | void write(in nsIObjectOutputStream aOutputStream);
|
|---|
| 65 | };
|
|---|
