Author: krosenvold
Date: Tue Oct 14 19:50:41 2014
New Revision: 1631856
URL: http://svn.apache.org/r1631856
Log:
Updated annotations
Added:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/annotations.xml
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/StringUtils.java
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/FileUtils.java
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/Java7Support.java
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/StringUtils.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/StringUtils.java?rev=1631856&r1=1631855&r2=1631856&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/StringUtils.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/StringUtils.java
Tue Oct 14 19:50:41 2014
@@ -129,7 +129,7 @@ public class StringUtils
* @param str the String to check
* @return true if the String is non-null, and not length zero
*/
- public static boolean isNotEmpty( String str )
+ public static boolean isNotEmpty( @Nullable String str )
{
return ( ( str != null ) && ( str.length() > 0 ) );
}
@@ -518,7 +518,7 @@ public class StringUtils
/**
* @see #split(String, String, int)
*/
- @Nonnull public static String[] split( @Nonnull String text, String
separator )
+ @Nonnull public static String[] split( @Nonnull String text, @Nullable
String separator )
{
return split( text, separator, -1 );
}
@@ -541,7 +541,7 @@ public class StringUtils
* array. A zero or negative value implies no limit.
* @return an array of parsed Strings
*/
- @Nonnull public static String[] split( @Nonnull String str, String
separator, int max )
+ @Nonnull public static String[] split( @Nonnull String str, @Nullable
String separator, int max )
{
StringTokenizer tok;
if ( separator == null )
@@ -615,7 +615,7 @@ public class StringUtils
* @param separator the separator character to use
* @return the joined String
*/
- @Nonnull public static String join( @Nonnull Object[] array, String
separator )
+ @Nonnull public static String join( @Nonnull Object[] array, @Nullable
String separator )
{
if ( separator == null )
{
@@ -984,7 +984,7 @@ public class StringUtils
* @return String prechomped
* @throws NullPointerException if str or sep is <code>null</code>
*/
- @Nonnull public static String getPrechomp( @Nonnull String str, String sep
)
+ @Nonnull public static String getPrechomp( @Nonnull String str, @Nonnull
String sep )
{
int idx = str.indexOf( sep );
if ( idx != -1 )
Added:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/annotations.xml
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/annotations.xml?rev=1631856&view=auto
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/annotations.xml
(added)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/annotations.xml
Tue Oct 14 19:50:41 2014
@@ -0,0 +1,229 @@
+<!--
+ 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.
+-->
+<root>
+ <item name='org.apache.maven.shared.utils.StringUtils boolean
contains(java.lang.String, char)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""null,_->false""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils boolean
contains(java.lang.String, java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""_,null->false;null,_->false""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils boolean
equals(java.lang.String, java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""null, null -> true""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils boolean
equalsIgnoreCase(java.lang.String, java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""null, null ->true""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils boolean
isAlpha(java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""null->false""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils boolean
isAlphaSpace(java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""null->false""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils boolean
isAlphanumeric(java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""null->false""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils boolean
isAlphanumericSpace(java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""null->false""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils boolean
isBlank(java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""null->true""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils boolean
isEmpty(java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""null->true""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils boolean
isNotBlank(java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""null ->false""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils boolean
isNumeric(java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""null->false""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils boolean
isWhitespace(java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""null->false""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils java.lang.String
capitalise(java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""!null->!null;null->null""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils java.lang.String
capitaliseAllWords(java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""!null->!null;null->null""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils java.lang.String
escape(java.lang.String, char[], char)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""null,_,_->null; !null,_,_ -> !null""/>
+ </annotation>
+ </item>
+ <item
+ name='org.apache.maven.shared.utils.StringUtils java.lang.String
getNestedString(java.lang.String, java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""null, _->null;!null,_->!null""/>
+ </annotation>
+ </item>
+ <item
+ name='org.apache.maven.shared.utils.StringUtils java.lang.String
getNestedString(java.lang.String, java.lang.String, java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""null,_,_->null;!null,_,_->!null""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils java.lang.String
left(java.lang.String, int)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""!null,_->!null;null,_->null""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils java.lang.String
lowerCase(java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""!null->!null;null->null""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils java.lang.String
mid(java.lang.String, int, int)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""!null,_,_->!null;null,_,_->null""/>
+ </annotation>
+ </item>
+ <item
+ name='org.apache.maven.shared.utils.StringUtils java.lang.String
quoteAndEscape(java.lang.String, char, char[], char[], char, boolean)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""null,_,_,_,_,_->null;
!null,_,_,_,_,_->!null""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils java.lang.String
replace(java.lang.String, char, char)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""!null,_,_->!null;null,_,_->null""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils java.lang.String
replace(java.lang.String, char, char, int)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""!null,_,_,_->!null;null,_,_,_->null""/>
+ </annotation>
+ </item>
+ <item
+ name='org.apache.maven.shared.utils.StringUtils java.lang.String
replace(java.lang.String, java.lang.String, java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""!null,_,_->!null;null,_,_->null""/>
+ </annotation>
+ </item>
+ <item
+ name='org.apache.maven.shared.utils.StringUtils java.lang.String
replace(java.lang.String, java.lang.String, java.lang.String, int)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""!null,_,_,_->!null;null,_,_,_->null""/>
+ </annotation>
+ </item>
+ <item
+ name='org.apache.maven.shared.utils.StringUtils java.lang.String
replaceOnce(java.lang.String, java.lang.String, java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""!null,_,_->!null;null,_,_->null""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils java.lang.String
reverse(java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""!null->!null;null->null""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils java.lang.String
right(java.lang.String, int)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""!null,_->!null;null,_->null""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils java.lang.String
stripEnd(java.lang.String, java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""!null,_->!null;null,_->null""/>
+ </annotation>
+ </item>
+ <item
+ name='org.apache.maven.shared.utils.StringUtils java.lang.String
stripStart(java.lang.String, java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""!null,_->!null;null,_->null""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils java.lang.String
substring(java.lang.String, int)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""null, _ -> null""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils java.lang.String
substring(java.lang.String, int, int)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""null, _ ,_ -> null""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils java.lang.String
swapCase(java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""!null->!null;null->null""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils java.lang.String
uncapitalise(java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""!null->!null;null->null""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils java.lang.String
uncapitaliseAllWords(java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""!null->!null;null->null""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils java.lang.String
unifyLineSeparators(java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""!null->!null;null->null""/>
+ </annotation>
+ </item>
+ <item
+ name='org.apache.maven.shared.utils.StringUtils java.lang.String
unifyLineSeparators(java.lang.String, java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""!null,_->!null;null,_->null""/>
+ </annotation>
+ </item>
+ <item name='org.apache.maven.shared.utils.StringUtils java.lang.String
upperCase(java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""!null->!null;null->null""/>
+ </annotation>
+ </item>
+ <item
+ name='org.apache.maven.shared.utils.StringUtils java.lang.String[]
stripAll(java.lang.String[], java.lang.String)'>
+ <annotation name='org.jetbrains.annotations.Contract'>
+ <val val=""null,_->null; !null, _ -> !null""/>
+ </annotation>
+ </item>
+</root>
\ No newline at end of file
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/FileUtils.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/FileUtils.java?rev=1631856&r1=1631855&r2=1631856&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/FileUtils.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/FileUtils.java
Tue Oct 14 19:50:41 2014
@@ -983,7 +983,7 @@ public class FileUtils
* @param path the path to normalize
* @return the normalized String, or <code>null</code> if too many ..'s.
*/
- public static String normalize( final String path )
+ public static @Nonnull String normalize( @Nonnull final String path )
{
String normalized = path;
// Resolve occurrences of "//" in the normalized path
@@ -1038,7 +1038,7 @@ public class FileUtils
* @param filename Absolute or relative file path to resolve.
* @return The canonical <code>File</code> of <code>filename</code>.
*/
- public static File resolveFile( final File baseFile, String filename )
+ public static @Nonnull File resolveFile( final File baseFile, @Nonnull
String filename )
{
String filenm = filename;
if ( '/' != File.separatorChar )
@@ -1115,7 +1115,7 @@ public class FileUtils
* @param file the file path
* @throws IOException if any
*/
- public static void forceDelete( final String file )
+ public static void forceDelete( @Nonnull final String file )
throws IOException
{
forceDelete( new File( file ) );
@@ -1157,7 +1157,7 @@ public class FileUtils
*/
- public static void delete( File file )
+ public static void delete( @Nonnull File file )
throws IOException
{
if ( Java7Support.isAtLeastJava7() )
@@ -1173,7 +1173,7 @@ public class FileUtils
}
}
- public static boolean deleteLegacyStyle( File file )
+ public static boolean deleteLegacyStyle( @Nonnull File file )
{
if ( Java7Support.isAtLeastJava7() )
{
@@ -1615,7 +1615,7 @@ public class FileUtils
* @param destinationDirectory the target dir
* @throws IOException if any
*/
- public static void copyDirectory( File sourceDirectory, File
destinationDirectory )
+ public static void copyDirectory( @Nonnull File sourceDirectory, @Nonnull
File destinationDirectory )
throws IOException
{
copyDirectory( sourceDirectory, destinationDirectory, "**", null );
@@ -2002,7 +2002,7 @@ public class FileUtils
* @param file the file to check
*
*/
- public static boolean isSymbolicLink( final File file )
+ public static boolean isSymbolicLink( final @Nonnull File file )
throws IOException
{
if ( Java7Support.isAtLeastJava7() )
@@ -2020,7 +2020,7 @@ public class FileUtils
* always return false for java versions prior to 1.7.
*
*/
- public static boolean isSymbolicLinkForSure( final File file )
+ public static boolean isSymbolicLinkForSure( final @Nonnull File file )
throws IOException
{
return Java7Support.isAtLeastJava7() && Java7Support.isSymLink( file );
@@ -2044,7 +2044,7 @@ public class FileUtils
* @return true if the file is a symbolic link or if we're on some crappy
os.
* false if the file is not a symlink or we're not able to detect
it.
*/
- static boolean isSymbolicLinkLegacy( final File file )
+ static boolean isSymbolicLinkLegacy( final @Nonnull File file )
throws IOException
{
final File canonical = new File( file.getCanonicalPath() );
Modified:
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/Java7Support.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/Java7Support.java?rev=1631856&r1=1631855&r2=1631856&view=diff
==============================================================================
---
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/Java7Support.java
(original)
+++
maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/io/Java7Support.java
Tue Oct 14 19:50:41 2014
@@ -173,7 +173,7 @@ public class Java7Support
* @throws IOException
*/
- public static void delete( File file ) throws IOException
+ public static void delete( @Nonnull File file ) throws IOException
{
try
{
