com.liferay.frontend.js.loader.modules.extender.npm.JSPackageDependency Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of release.portal.api Show documentation

POM was created by Sonatype Nexus

There is a newer version: 7.4.3.112-ga112

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.frontend.js.loader.modules.extender.npm;

/**
 * Represents an NPM package dependency (i.e., another NPM package).
 *
 * @author Iván Zaera
 */
public class JSPackageDependency {

	/**
	 * Constructs a JSPackageDependency with the JS package,
	 * package name, and version constraints.
	 *
	 * @param jsPackage the package declaring the dependency
	 * @param packageName the dependency's package name
	 * @param versionConstraints the NPM semantic version expression defining
	 *        the suitable versions for the dependency
	 */
	public JSPackageDependency(
		JSPackage jsPackage, String packageName, String versionConstraints) {

		_jsPackage = jsPackage;
		_packageName = packageName;
		_versionConstraints = versionConstraints;
	}

	/**
	 * Returns the NPM package declaring the dependency.
	 *
	 * @return the NPM package
	 */
	public JSPackage getJSPackage() {
		return _jsPackage;
	}

	/**
	 * Returns the dependency's package name.
	 *
	 * @return the dependency's package name
	 */
	public String getPackageName() {
		return _packageName;
	}

	/**
	 * Returns the NPM semantic version expression defining the suitable
	 * versions for the dependency.
	 *
	 * @return the NPM semantic version expression
	 */
	public String getVersionConstraints() {
		return _versionConstraints;
	}

	private final JSPackage _jsPackage;
	private final String _packageName;
	private final String _versionConstraints;

}