1/*
2 * Copyright (c) 2009-2010 jMonkeyEngine
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met:
8 *
9 * * Redistributions of source code must retain the above copyright
10 *   notice, this list of conditions and the following disclaimer.
11 *
12 * * Redistributions in binary form must reproduce the above copyright
13 *   notice, this list of conditions and the following disclaimer in the
14 *   documentation and/or other materials provided with the distribution.
15 *
16 * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
17 *   may be used to endorse or promote products derived from this software
18 *   without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33package com.jme3.asset;
34
35import java.io.InputStream;
36
37/**
38 * The result of locating an asset through an AssetKey. Provides
39 * a means to read the asset data through an InputStream.
40 *
41 * @author Kirill Vainer
42 */
43public abstract class AssetInfo {
44
45    protected AssetManager manager;
46    protected AssetKey key;
47
48    public AssetInfo(AssetManager manager, AssetKey key) {
49        this.manager = manager;
50        this.key = key;
51    }
52
53    public AssetKey getKey() {
54        return key;
55    }
56
57    public AssetManager getManager() {
58        return manager;
59    }
60
61    @Override
62    public String toString(){
63        return getClass().getName() + "[" + "key=" + key + "]";
64    }
65
66    /**
67     * Implementations of this method should return an {@link InputStream}
68     * allowing access to the data represented by the {@link AssetKey}.
69     * <p>
70     * Each invocation of this method should return a new stream to the
71     * asset data, starting at the beginning of the file.
72     *
73     * @return The asset data.
74     */
75    public abstract InputStream openStream();
76
77}
78