-
Notifications
You must be signed in to change notification settings - Fork 2.8k
[MNG-8761] Add Maven 3 MavenToolchainsXpp3Reader/Writer #2412
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
151 changes: 151 additions & 0 deletions
151
...del/src/main/java/org/apache/maven/toolchain/model/io/xpp3/MavenToolchainsXpp3Reader.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you 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. | ||
| */ | ||
| package org.apache.maven.toolchain.model.io.xpp3; | ||
|
|
||
| import javax.xml.stream.XMLStreamException; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.io.Reader; | ||
|
|
||
| import org.apache.maven.toolchain.model.PersistedToolchains; | ||
| import org.apache.maven.toolchain.v4.MavenToolchainsStaxReader; | ||
| import org.codehaus.plexus.util.xml.XmlStreamReader; | ||
| import org.codehaus.plexus.util.xml.pull.XmlPullParser; | ||
| import org.codehaus.plexus.util.xml.pull.XmlPullParserException; | ||
|
|
||
| /** | ||
| * | ||
| * @deprecated use MavenToolchainsStaxReader. | ||
| */ | ||
| @Deprecated(since = "4.0.0") | ||
| public class MavenToolchainsXpp3Reader { | ||
|
|
||
| private final MavenToolchainsStaxReader delegate; | ||
|
|
||
| public MavenToolchainsXpp3Reader() { | ||
| delegate = new MavenToolchainsStaxReader(); | ||
| } | ||
|
|
||
| public MavenToolchainsXpp3Reader(ContentTransformer contentTransformer) { | ||
| delegate = contentTransformer != null | ||
| ? new MavenToolchainsStaxReader(contentTransformer::transform) | ||
| : new MavenToolchainsStaxReader(); | ||
| } | ||
|
|
||
| /** | ||
| * Sets the state of the "add default entities" flag. | ||
| * | ||
| * @param addDefaultEntities a addDefaultEntities object. | ||
| */ | ||
| public void setAddDefaultEntities(boolean addDefaultEntities) { | ||
| delegate.setAddDefaultEntities(addDefaultEntities); | ||
| } | ||
|
|
||
| /** | ||
| * Returns the state of the "add default entities" flag. | ||
| * | ||
| * @return boolean | ||
| */ | ||
| public boolean getAddDefaultEntities() { | ||
| return delegate.getAddDefaultEntities(); | ||
| } | ||
|
|
||
| /** | ||
| * Method read. | ||
| * | ||
| * @param parser a parser object. | ||
| * @param strict a strict object. | ||
| * @return PersistedToolchains | ||
| * @throws IOException IOException if any. | ||
| * @throws XmlPullParserException XmlPullParserException if | ||
| * any. | ||
| */ | ||
| public PersistedToolchains read(XmlPullParser parser, boolean strict) throws IOException, XmlPullParserException { | ||
| throw new UnsupportedOperationException("Not yet implemented"); | ||
| } | ||
|
|
||
| /** | ||
| * @param reader a reader object. | ||
| * @param strict a strict object. | ||
| * @return PersistedToolchains | ||
| * @throws IOException IOException if any. | ||
| * @throws XmlPullParserException XmlPullParserException if | ||
| * any. | ||
| * @see XmlStreamReader | ||
| */ | ||
| public PersistedToolchains read(Reader reader, boolean strict) throws IOException, XmlPullParserException { | ||
| try { | ||
| return new PersistedToolchains(delegate.read(reader, strict, null)); | ||
| } catch (XMLStreamException e) { | ||
| throw new XmlPullParserException(e.getMessage(), null, e); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @param reader a reader object. | ||
| * @return PersistedToolchains | ||
| * @throws IOException IOException if any. | ||
| * @throws XmlPullParserException XmlPullParserException if | ||
| * any. | ||
| * @see XmlStreamReader | ||
| */ | ||
| public PersistedToolchains read(Reader reader) throws IOException, XmlPullParserException { | ||
| return read(reader, true); | ||
| } | ||
|
|
||
| /** | ||
| * Method read. | ||
| * | ||
| * @param in a in object. | ||
| * @param strict a strict object. | ||
| * @return PersistedToolchains | ||
| * @throws IOException IOException if any. | ||
| * @throws XmlPullParserException XmlPullParserException if | ||
| * any. | ||
| */ | ||
| public PersistedToolchains read(InputStream in, boolean strict) throws IOException, XmlPullParserException { | ||
| return read(new XmlStreamReader(in), strict); | ||
| } | ||
|
|
||
| /** | ||
| * Method read. | ||
| * | ||
| * @param in a in object. | ||
| * @return PersistedToolchains | ||
| * @throws IOException IOException if any. | ||
| * @throws XmlPullParserException XmlPullParserException if | ||
| * any. | ||
| */ | ||
| public PersistedToolchains read(InputStream in) throws IOException, XmlPullParserException { | ||
| return read(new XmlStreamReader(in)); | ||
| } | ||
|
|
||
| public interface ContentTransformer { | ||
| /** | ||
| * Interpolate the value read from the xpp3 document | ||
| * | ||
| * @param source The source value | ||
| * @param fieldName A description of the field being interpolated. The implementation may use this to | ||
| * log stuff. | ||
| * @return The interpolated value. | ||
| */ | ||
| String transform(String source, String fieldName); | ||
| } | ||
| } | ||
85 changes: 85 additions & 0 deletions
85
...del/src/main/java/org/apache/maven/toolchain/model/io/xpp3/MavenToolchainsXpp3Writer.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,85 @@ | ||||||||
| /* | ||||||||
| * Licensed to the Apache Software Foundation (ASF) under one | ||||||||
| * or more contributor license agreements. See the NOTICE file | ||||||||
| * distributed with this work for additional information | ||||||||
| * regarding copyright ownership. The ASF licenses this file | ||||||||
| * to you 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. | ||||||||
| */ | ||||||||
| package org.apache.maven.toolchain.model.io.xpp3; | ||||||||
|
|
||||||||
| import javax.xml.stream.XMLStreamException; | ||||||||
|
|
||||||||
| import java.io.IOException; | ||||||||
| import java.io.OutputStream; | ||||||||
| import java.io.Writer; | ||||||||
|
|
||||||||
| import org.apache.maven.toolchain.model.PersistedToolchains; | ||||||||
| import org.apache.maven.toolchain.v4.MavenToolchainsStaxWriter; | ||||||||
|
|
||||||||
| /** | ||||||||
| * | ||||||||
| * @deprecated use MavenToolchainsStaxWriter. | ||||||||
| */ | ||||||||
| @Deprecated(since = "4.0.0") | ||||||||
| public class MavenToolchainsXpp3Writer { | ||||||||
| // --------------------------/ | ||||||||
| // - Class/Member Variables -/ | ||||||||
| // --------------------------/ | ||||||||
|
Comment on lines
+36
to
+38
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
not seen else where. |
||||||||
|
|
||||||||
| private final MavenToolchainsStaxWriter delegate; | ||||||||
|
|
||||||||
| public MavenToolchainsXpp3Writer() { | ||||||||
| delegate = new MavenToolchainsStaxWriter(); | ||||||||
| delegate.setAddLocationInformation(false); | ||||||||
| } | ||||||||
|
|
||||||||
| /** | ||||||||
| * Method setFileComment. | ||||||||
| * | ||||||||
| * @param fileComment a fileComment object. | ||||||||
| */ | ||||||||
| public void setFileComment(String fileComment) { | ||||||||
| delegate.setFileComment(fileComment); | ||||||||
| } | ||||||||
|
|
||||||||
| /** | ||||||||
| * Method write. | ||||||||
| * | ||||||||
| * @param writer a writer object. | ||||||||
| * @param persistedToolchains a persistedToolchains object. | ||||||||
| * @throws IOException java.io.IOException if any. | ||||||||
| */ | ||||||||
| public void write(Writer writer, PersistedToolchains persistedToolchains) throws IOException { | ||||||||
| try { | ||||||||
| delegate.write(writer, persistedToolchains.getDelegate()); | ||||||||
| } catch (XMLStreamException e) { | ||||||||
| throw new IOException(e); | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| /** | ||||||||
| * Method write. | ||||||||
| * | ||||||||
| * @param stream a stream object. | ||||||||
| * @param persistedToolchains a persistedToolchains object. | ||||||||
| * @throws IOException java.io.IOException if any. | ||||||||
| */ | ||||||||
| public void write(OutputStream stream, PersistedToolchains persistedToolchains) throws IOException { | ||||||||
| try { | ||||||||
| delegate.write(stream, persistedToolchains.getDelegate()); | ||||||||
| } catch (XMLStreamException e) { | ||||||||
| throw new IOException(e); | ||||||||
| } | ||||||||
| } | ||||||||
| } | ||||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nicely done.