1/*
2 * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25package jdk.tools.jlink.internal;
26
27import jdk.tools.jlink.plugin.ResourcePool;
28
29/**
30 * Plugin wishing to pre-visit the resources must implement this interface.
31 * Pre-visit can be useful when some activities are required prior to the actual
32 * Resource visit.
33 * The StringTable plays a special role during previsit. The passed Strings are NOT
34 * added to the jimage file. The string usage is tracked in order to build an efficient
35 * string storage.
36 */
37public interface ResourcePrevisitor {
38
39    /**
40     * Previsit the collection of resources.
41     *
42     * @param resources Read only resources.
43     * @param strings StringTable instance. Add string to the StringTable to track string
44     * usage.
45     */
46    public void previsit(ResourcePool resources, StringTable strings);
47}
48