-
Notifications
You must be signed in to change notification settings - Fork 10
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
[MASSEMBLY-617] : Add new FileMapper for giving a suffix to filename … #14
Changes from 3 commits
9370b32
94833d1
b29e094
9ffe46a
8954c8e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
package org.codehaus.plexus.components.io.filemappers; | ||
|
||
/* | ||
* Copyright 2007 The Codehaus Foundation. | ||
* | ||
* Licensed 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. | ||
*/ | ||
|
||
import javax.annotation.Nonnull; | ||
|
||
import org.codehaus.plexus.util.StringUtils; | ||
|
||
/** | ||
* A file mapper, which maps by adding a suffix. | ||
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. Would be nice if make it clear that the suffix is added before the dot. It is mentioned in the site docs but it would be nice if you state it here as well (so it is visible in the IDEs). |
||
*/ | ||
public class SuffixFileMapper extends AbstractFileMapper | ||
{ | ||
/** | ||
* The suffix mappers role-hint: "suffix". | ||
*/ | ||
public static final String ROLE_HINT = "suffix"; | ||
|
||
private String suffix; | ||
|
||
@Nonnull public String getMappedFileName( @Nonnull String name ) | ||
{ | ||
final String s = super.getMappedFileName( name ); // Check for null, etc. | ||
return getMappedFileName( suffix, s ); | ||
} | ||
|
||
/** | ||
* Returns the suffix to add. | ||
*/ | ||
public String getSuffix() | ||
{ | ||
return suffix; | ||
} | ||
|
||
/** | ||
* Sets the suffix to add. | ||
*/ | ||
public void setSuffix( String suffix ) | ||
{ | ||
this.suffix = suffix; | ||
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. As
Not all marchers all have that (the regex one does not have) but I think as most have it is better this way. |
||
} | ||
|
||
/** | ||
* Performs the mapping of a file name by adding a suffix. | ||
*/ | ||
public static String getMappedFileName( String suffix, String name ) | ||
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. I guess you followed the 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. Ok I have no problem with that |
||
{ | ||
String nameWithSuffix = name; | ||
if ( StringUtils.isNotBlank( suffix ) ) | ||
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. The rest of the mappers throw |
||
{ | ||
final int dirSep = Math.max( name.lastIndexOf( '/' ), name.lastIndexOf( '\\' ) ); | ||
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. I don't think you need to split the file name into file name and directory name. See 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. Yes actually I try to do the same thing as |
||
String filename = dirSep > 0 ? name.substring( dirSep +1 ) : name; | ||
String dirname = dirSep > 0 ? name.substring( 0, dirSep +1 ) : ""; | ||
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. I hope I don't get annoying with that but I think there is missing white space after the plus sign. 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. No problem code style must be respected |
||
if ( filename.contains( "." ) ) | ||
{ | ||
String beforeExtension = filename.substring( 0, filename.indexOf( '.' ) ); | ||
String afterExtension = filename.substring( filename.indexOf( '.' ) + 1 ) ; | ||
nameWithSuffix = dirname + beforeExtension + suffix + "." + afterExtension; | ||
} | ||
else | ||
{ | ||
nameWithSuffix += suffix; | ||
} | ||
} | ||
return nameWithSuffix; | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -30,6 +30,10 @@ File Mappers | |
|
||
* The {{{#Merging File Mapper}Merging File Mapper}}; its role hint is | ||
"merge". | ||
|
||
* The {{{#Suffix File Mapper}Suffix File Mapper}}; its role hint is | ||
"suffix". | ||
|
||
|
||
* {Identity Mapper} | ||
|
||
|
@@ -94,3 +98,22 @@ File Mappers | |
----------------------------------------------------------------------------- | ||
|
||
The merging file mapper uses the role hint "merge". | ||
|
||
* {Suffix File Mapper} | ||
|
||
The {{{./apidocs/org/codehaus/plexus/components/io/filemappers/SuffixFileMapper.html}suffix | ||
file mapper}} add the given suffix to the filename. The suffix will be added before the file | ||
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. I think the correct is 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. oops you see my bad English :( |
||
extension. Examples : | ||
theFile.txt => theFileNiceSuffix.txt | ||
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. The examples will be displayed on one line as the new lines will be stripped. If you wrap them as code that would solve the problem and they would stand out as well. And would be great if you add example with dot in the file name as it would make clear how the mapper behaves in such cases. 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. I have still the following example : dir/archive.tar.gz => dir/archiveNiceSuffix.tar.gz 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. It is ok. My bad, didn't read the docs carefully enough. Sorry about that. |
||
dir/file.java => dir/fileNiceSuffix.java | ||
fileWithoutExtension => fileWithoutExtensionNiceSuffix | ||
dir/archive.tar.gz => dir/archiveNiceSuffix.tar.gz | ||
It would be configured as follows: | ||
|
||
----------------------------------------------------------------------------- | ||
<fileMapper implementation="org.codehaus.plexus.components.io.filemappers.SuffixFileMapper"> | ||
<suffix>NiceSuffix</suffix> | ||
</fileMapper> | ||
----------------------------------------------------------------------------- | ||
|
||
The suffix file mapper uses the role hint "suffix". |
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.
I've just noticed that this is the old license header. Judging by the other new files in the codehaus-plexus project you can just delete this line and keep the rest (the Apache license).