1 /**
2 * This file Copyright (c) 2003-2018 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.module.model;
35
36 /**
37 * Models a dependency between modules.
38 */
39 public class DependencyDefinition {
40 private String name;
41 private String version;
42
43 /**
44 * An optional dependency is not mandatory but still influences the order of modules loading.
45 */
46 private boolean optional;
47
48 public DependencyDefinition() {
49 }
50
51 public DependencyDefinition(String name, String version, boolean optional) {
52 this.name = name;
53 this.version = version;
54 this.optional = optional;
55 }
56
57 public VersionRange getVersionRange() {
58 return VersionRange.parse(version);
59 }
60
61 public String getName() {
62 return name;
63 }
64
65 public void setName(String name) {
66 this.name = name;
67 }
68
69 public String getVersion() {
70 return version;
71 }
72
73 public void setVersion(String version) {
74 this.version = version;
75 }
76
77 public boolean isOptional() {
78 return optional;
79 }
80
81 public void setOptional(boolean optional) {
82 this.optional = optional;
83 }
84
85 @Override
86 public String toString() {
87 final StringBuilder s = new StringBuilder();
88 s.append(name).append(" (");
89 if (version != null) {
90 s.append("version ").append(version);
91 } else {
92 s.append("unspecified version");
93 }
94 if (optional) {
95 s.append(" - optional");
96 }
97 s.append(")");
98 return s.toString();
99 }
100 }