modules/libjar/nsIJARURI.idl

changeset 0
6474c204b198
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/modules/libjar/nsIJARURI.idl	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,38 @@
     1.4 +/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
     1.5 + *
     1.6 + * This Source Code Form is subject to the terms of the Mozilla Public
     1.7 + * License, v. 2.0. If a copy of the MPL was not distributed with this
     1.8 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
     1.9 +
    1.10 +#include "nsIURL.idl"
    1.11 +
    1.12 +/**
    1.13 + * JAR URLs have the following syntax
    1.14 + *
    1.15 + * jar:<jar-file-uri>!/<jar-entry>
    1.16 + *
    1.17 + * EXAMPLE: jar:http://www.big.com/blue.jar!/ocean.html
    1.18 + *
    1.19 + * The nsIURL methods operate on the <jar-entry> part of the spec.
    1.20 + */
    1.21 +[scriptable, uuid(1ee60719-c056-43b3-8f54-6a6e7ba0ca6c)]
    1.22 +interface nsIJARURI : nsIURL {
    1.23 +
    1.24 +    /**
    1.25 +     * Returns the root URI (the one for the actual JAR file) for this JAR
    1.26 +     * (e.g., http://www.big.com/blue.jar).
    1.27 +     */
    1.28 +    readonly attribute nsIURI JARFile;
    1.29 +
    1.30 +    /**
    1.31 +     * Returns the entry specified for this JAR URI (e.g., "ocean.html").  This
    1.32 +     * value may contain %-escaped byte sequences.
    1.33 +     */
    1.34 +    attribute AUTF8String JAREntry;
    1.35 +
    1.36 +    /**
    1.37 +     * Create a clone of the JAR URI with a new root URI (the URI for the
    1.38 +     * actual JAR file).
    1.39 +     */
    1.40 +    nsIJARURI cloneWithJARFile(in nsIURI jarFile);
    1.41 +};

mercurial