View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.model.transform;
20  
21  import java.util.List;
22  import java.util.function.Function;
23  import org.apache.maven.model.transform.pull.NodeBufferingParser;
24  import org.codehaus.plexus.util.xml.pull.XmlPullParser;
25  
26  /**
27   * Resolves all ci-friendly properties occurrences between version-tags
28   *
29   * @author Robert Scholte
30   * @author Guillaume Nodet
31   * @since 4.0.0
32   */
33  class CiFriendlyXMLFilter extends NodeBufferingParser {
34      private final boolean replace;
35  
36      private Function<String, String> replaceChain = Function.identity();
37  
38      CiFriendlyXMLFilter(XmlPullParser xmlPullParser, boolean replace) {
39          super(xmlPullParser, "version");
40          this.replace = replace;
41      }
42  
43      public CiFriendlyXMLFilter setChangelist(String changelist) {
44          replaceChain = replaceChain.andThen(t -> t.replace("${changelist}", changelist));
45          return this;
46      }
47  
48      public CiFriendlyXMLFilter setRevision(String revision) {
49          replaceChain = replaceChain.andThen(t -> t.replace("${revision}", revision));
50          return this;
51      }
52  
53      public CiFriendlyXMLFilter setSha1(String sha1) {
54          replaceChain = replaceChain.andThen(t -> t.replace("${sha1}", sha1));
55          return this;
56      }
57  
58      /**
59       * @return {@code true} is any of the ci properties is set, otherwise {@code false}
60       */
61      public boolean isSet() {
62          return !replaceChain.equals(Function.identity());
63      }
64  
65      @Override
66      protected void process(List<Event> buffer) {
67          for (Event event : buffer) {
68              if (event.event == TEXT && replace && event.text.contains("${")) {
69                  event.text = replaceChain.apply(event.text);
70              }
71              pushEvent(event);
72          }
73      }
74  }