uk.org.retep.util.string.GlobMatcher Maven / Gradle / Ivy
/*
* Copyright (c) 1998-2010, Peter T Mount
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* - Neither the name of the retep.org.uk nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
*
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
* OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package uk.org.retep.util.string;
import javax.annotation.concurrent.ThreadSafe;
import static uk.org.retep.util.string.StringUtils.isStringEmpty;
/**
* Simple glob matching, i.e. patterns using * as a wildcard.
* @author peter
* @since 8.8
*/
@ThreadSafe
public class GlobMatcher
{
public static final String GLOB = "*";
/**
* Check a string to see if it matches a pattern.
*
* In the initial version this will allow the * at the start and end
* of the pattern only.
*
* @param glob pattern to match
* @param src string to test
* @return true if src matches glob
*/
public static boolean matches( final String glob, final String src )
{
if( isStringEmpty( glob ) || isStringEmpty( src ) )
{
return false;
}
if( GLOB.equals( glob ) )
{
// Match everything
return true;
}
else if( glob.startsWith( GLOB ) )
{
return src.endsWith( glob.substring( 1 ) );
}
else if( glob.endsWith( GLOB ) )
{
return src.startsWith( glob.substring( 0, glob.length() - 1 ) );
}
else
{
return glob.equals( src );
}
}
/**
* Check a string to see if it matches a pattern.
*
* In the initial version this will allow the * at the start and end
* of the pattern only.
*
* @param glob pattern to match
* @param src string to test
* @return the portion of src that matches
*/
public static String extractMatch( final String glob, final String src )
{
if( isStringEmpty( glob ) || isStringEmpty( src ) )
{
return null;
}
if( GLOB.equals( glob ) )
{
// Match everything
return src;
}
else if( glob.startsWith( GLOB ) &&
src.endsWith( glob.substring( 1 ) ) )
{
return src.substring( 0, src.length() - glob.length() + 1 );
}
else if( glob.endsWith( GLOB ) &&
src.startsWith( glob.substring( 0, glob.length() - 1 ) ) )
{
return src.substring( glob.length() - 1 );
}
else if( glob.equals( src ) )
{
return src;
}
return null;
}
private GlobMatcher()
{
}
}