org.neo4j.configuration.helpers.GlobbingPattern Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-configuration Show documentation
Code responsible for parsing the Neo4j configuration.
There is a newer version: 5.26.0
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.configuration.helpers;

import java.util.ArrayList;
import java.util.List;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;

import org.neo4j.annotations.api.PublicApi;

/**
 * Simple globbing pattern with support for '*' and '?'.
 */
@PublicApi
public final class GlobbingPattern
{
    private final String originalString;
    private final Pattern regexPattern;

    public GlobbingPattern( String pattern )
    {
        originalString = pattern;
        try
        {
            regexPattern = buildRegex( pattern );
        }
        catch ( PatternSyntaxException e )
        {
            throw new IllegalArgumentException( "Invalid globbing pattern '" + pattern + "'", e );
        }
    }

    public static List create( String... patterns )
    {
        ArrayList globbingPatterns = new ArrayList<>();
        for ( String pattern : patterns )
        {
            globbingPatterns.add( new GlobbingPattern( pattern ) );
        }
        return globbingPatterns;
    }

    public boolean matches( String value )
    {
        return regexPattern.matcher( value ).matches();
    }

    @Override
    public String toString()
    {
        return originalString;
    }

    @Override
    public boolean equals( Object o )
    {
        if ( this == o )
        {
            return true;
        }
        if ( o == null || getClass() != o.getClass() )
        {
            return false;
        }
        GlobbingPattern that = (GlobbingPattern) o;
        return originalString.equals( that.originalString );
    }

    @Override
    public int hashCode()
    {
        return originalString.hashCode();
    }

    private static Pattern buildRegex( String globbingPattern )
    {
        StringBuilder patternString = new StringBuilder();
        for ( int i = 0; i < globbingPattern.length(); i++ )
        {
            char ch = globbingPattern.charAt( i );
            if ( ch == '*' )
            {
                patternString.append( ".*" );
            }
            else if ( ch == '?' )
            {
                patternString.append( "." );
            }
            else if ( ch == '.' || ch == '-' )
            {
                patternString.append( "\\" ).append( ch );
            }
            else
            {
                patternString.append( ch );
            }
        }
        return Pattern.compile( patternString.toString() );
    }
}