Debian Codegraph @

bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/metadata/IArtifactKey.java

raw
1 /*******************************************************************************
2 * Copyright (c) 2007, 2017 IBM Corporation and others.
3 *
4 * This program and the accompanying materials
5 * are made available under the terms of the Eclipse Public License 2.0
6 * which accompanies this distribution, and is available at
7 * https://www.eclipse.org/legal/epl-2.0/
8 *
9 * SPDX-License-Identifier: EPL-2.0
10 *
11 * Contributors:
12 * IBM Corporation - initial API and implementation
13 *******************************************************************************/
14 package org.eclipse.equinox.p2.metadata;
15
16 /**
17 * Provide standardised artifact information to uniquely identify the
18 * corresponding bytes (perhaps not stored as a file).
19 * <p>
20 * Artifact keys represent both a unique opaque identifier as well as structured
21 * and standardised pieces of information.
22 *
23 * @noimplement This interface is not intended to be implemented by clients.
24 * @noextend This interface is not intended to be extended by clients.
25 * @since 2.0
26 */
27 public interface IArtifactKey extends IVersionedId {
28
29 /**
30 * Returns the classifier for this artifact key. The returned value can be empty.
31 * @return the classifier segment of the key.
32 */
33 public String getClassifier();
34
35 /**
36 * Returns the id for this artifact key.
37 * @return the id segment of the key.
38 */
39 @Override
40 public String getId();
41
42 /**
43 * Returns the version for this artifact key.
44 * @return the version segment of the key.
45 */
46 @Override
47 public Version getVersion();
48
49 /**
50 * Returns the canonical string form of this artifact key.
51 * @return the canonical string representing this key
52 */
53 public String toExternalForm();
54 }