< prev index next >

src/java.base/share/classes/jdk/internal/jimage/ImageStrings.java

Print this page

 1 /*
 2  * Copyright (c) 2014, 2021, 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  */
25 
26 package jdk.internal.jimage;
27 
28 /**
29  * @implNote This interface needs to maintain JDK 8 source compatibility.
30  *
31  * It is used internally in the JDK to implement jimage/jrtfs access,
32  * but also compiled and delivered as part of the jrtfs.jar to support access
33  * to the jimage file provided by the shipped JDK by tools running on JDK 8.
34  */
35 public interface ImageStrings {

















36     String get(int offset);
37 
38     int add(final String string);
39 
40     /**
41      * If there's a string at {@code offset} matching in full a substring of
42      * {@code string} starting at {@code stringOffset}, return the length
43      * of that string. Otherwise returns -1. Optional operation.
44      */
45     default int match(int offset, String string, int stringOffset) {
46         throw new UnsupportedOperationException();
47     }
48 
49 }

 1 /*
 2  * Copyright (c) 2014, 2025, 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  */
25 
26 package jdk.internal.jimage;
27 
28 /**
29  * @implNote This interface needs to maintain JDK 8 source compatibility.
30  *
31  * It is used internally in the JDK to implement jimage/jrtfs access,
32  * but also compiled and delivered as part of the jrtfs.jar to support access
33  * to the jimage file provided by the shipped JDK by tools running on JDK 8.
34  */
35 public interface ImageStrings {
36     // String offset constants are useful for efficient classification
37     // of location entries without string comparison.
38     // They are validated during initialization of ImageStringsWriter.
39     //
40     // Adding new strings (with larger offsets) is possible without changing
41     // the jimage version number, but any change to existing strings must be
42     // accompanied by a jimage version number change.
43 
44     /** Fixed offset for the empty string in the strings table. */
45     int EMPTY_STRING_OFFSET = 0;
46     /** Fixed offset for the string "class" in the strings table. */
47     int CLASS_STRING_OFFSET = 1;
48     /** Fixed offset for the string "modules" in the strings table. */
49     int MODULES_STRING_OFFSET = 7;
50     /** Fixed offset for the string "packages" in the strings table. */
51     int PACKAGES_STRING_OFFSET = 15;
52 
53     String get(int offset);
54 
55     int add(final String string);
56 
57     /**
58      * If there's a string at {@code offset} matching in full a substring of
59      * {@code string} starting at {@code stringOffset}, return the length
60      * of that string. Otherwise returns -1. Optional operation.
61      */
62     default int match(int offset, String string, int stringOffset) {
63         throw new UnsupportedOperationException();
64     }
65 
66 }
< prev index next >