1 /**
2 * This file Copyright (c) 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.config.source;
35
36 import org.apache.commons.lang3.builder.ToStringBuilder;
37 import org.apache.commons.lang3.builder.ToStringStyle;
38
39 /**
40 * Object representation of {@link info.magnolia.annotation.deprecation.MgnlDeprecated}.
41 */
42 public class Deprecation {
43
44 private final String since;
45 private final String description;
46
47 private Deprecation(String since, String description) {
48 this.since = since;
49 this.description = description;
50 }
51
52 public String since() {
53 return this.since;
54 }
55
56 public String description() {
57 return this.description;
58 }
59
60 /**
61 * Builder for {@link Deprecation}.
62 */
63 public static class Builder {
64
65 private String since;
66 private String description;
67
68 public Builder since(String since) {
69 this.since = since;
70 return this;
71 }
72
73 public Builder description(String description) {
74 this.description = description;
75 return this;
76 }
77
78 public Deprecation build() {
79 return new Deprecation(this.since, this.description);
80 }
81 }
82
83 /**
84 * Static method which returns a {@link Builder}.
85 */
86 public static Builder deprecation() {
87 return new Builder();
88 }
89
90 @Override
91 public String toString() {
92 return new ToStringBuilder(this, ToStringStyle.NO_CLASS_NAME_STYLE).append("Since", this.since).append("Description", description).toString();
93 }
94 }