com.sap.psr.vulas.java.JavaPackageId Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lang-java Show documentation
There is a newer version: 3.1.15
/**
 * This file is part of Eclipse Steady.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Copyright (c) 2018 SAP SE or an SAP affiliate company. All rights reserved.
 */
package com.sap.psr.vulas.java;

import com.sap.psr.vulas.ConstructId;

/**
 * Identifies a Java package by its fully qualified name.
 */
public class JavaPackageId extends JavaId {
	
	/**
	 * The default package has an empty string as qualified name. It is used
	 * when working with classes, interfaces or enums that do not belong to
	 * a package.
	 */
	public final static JavaPackageId DEFAULT_PACKAGE = new JavaPackageId(null);

	/** Fully qualified package identifier. */
	protected String packageId = null;
	/**
	 * Constructor for JavaPackageId.
	 *
	 * @param _qualified_name a {@link java.lang.String} object.
	 */
	public JavaPackageId(String _qualified_name) {
		super(JavaId.Type.PACKAGE);
		this.packageId = (_qualified_name==null ? "" : _qualified_name);
	}
	
	/**
	 * Returns the complete package name, including parent packages.
	 *
	 * @return a {@link java.lang.String} object.
	 */
	public String getQualifiedName() { return this.packageId; }
	
	/**
	 * For packages, the method returns the qualified name.
	 *
	 * @return a {@link java.lang.String} object.
	 */
	public String getName() { return this.getQualifiedName(); }
	
	/**
	 * For packages, the method returns the qualified name.
	 *
	 * @return a {@link java.lang.String} object.
	 */
	public String getSimpleName() { return this.getQualifiedName(); }
	
	/**
	 * For packages, this method always returns null.
	 *
	 * @return a {@link com.sap.psr.vulas.ConstructId} object.
	 */
	public ConstructId getDefinitionContext() { return null; }
	
	/**
	 * For packages, this method always returns null.
	 *
	 * @return a {@link com.sap.psr.vulas.java.JavaPackageId} object.
	 */
	public JavaPackageId getJavaPackageId() { return null; }
	
	/**
	 * Returns true if the given {@link JavaPackageId} corresponds to the {@link JavaPackageId#DEFAULT_PACKAGE}, false otherwise.
	 *
	 * @param _pid a {@link com.sap.psr.vulas.java.JavaPackageId} object.
	 * @return a boolean.
	 */
	public static final boolean isDefaultPackage(JavaPackageId _pid) { return DEFAULT_PACKAGE.equals(_pid); }
}