modules/libjar/nsIJARURI.idl

Thu, 22 Jan 2015 13:21:57 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 22 Jan 2015 13:21:57 +0100
branch
TOR_BUG_9701
changeset 15
b8a032363ba2
permissions
-rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

michael@0 1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
michael@0 2 *
michael@0 3 * This Source Code Form is subject to the terms of the Mozilla Public
michael@0 4 * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0 5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0 6
michael@0 7 #include "nsIURL.idl"
michael@0 8
michael@0 9 /**
michael@0 10 * JAR URLs have the following syntax
michael@0 11 *
michael@0 12 * jar:<jar-file-uri>!/<jar-entry>
michael@0 13 *
michael@0 14 * EXAMPLE: jar:http://www.big.com/blue.jar!/ocean.html
michael@0 15 *
michael@0 16 * The nsIURL methods operate on the <jar-entry> part of the spec.
michael@0 17 */
michael@0 18 [scriptable, uuid(1ee60719-c056-43b3-8f54-6a6e7ba0ca6c)]
michael@0 19 interface nsIJARURI : nsIURL {
michael@0 20
michael@0 21 /**
michael@0 22 * Returns the root URI (the one for the actual JAR file) for this JAR
michael@0 23 * (e.g., http://www.big.com/blue.jar).
michael@0 24 */
michael@0 25 readonly attribute nsIURI JARFile;
michael@0 26
michael@0 27 /**
michael@0 28 * Returns the entry specified for this JAR URI (e.g., "ocean.html"). This
michael@0 29 * value may contain %-escaped byte sequences.
michael@0 30 */
michael@0 31 attribute AUTF8String JAREntry;
michael@0 32
michael@0 33 /**
michael@0 34 * Create a clone of the JAR URI with a new root URI (the URI for the
michael@0 35 * actual JAR file).
michael@0 36 */
michael@0 37 nsIJARURI cloneWithJARFile(in nsIURI jarFile);
michael@0 38 };

mercurial