com.eightkdata.mongowp.bson.BsonRegex Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bson-core Show documentation
There is a newer version: 0.50.0
/*
 * This file is part of MongoWP.
 *
 * MongoWP is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MongoWP 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with bson. If not, see .
 *
 * Copyright (C) 2016 8Kdata.
 * 
 */

package com.eightkdata.mongowp.bson;

import java.io.Serializable;
import java.util.Comparator;
import java.util.EnumSet;
import java.util.Set;
import javax.annotation.Nonnull;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 *
 */
public interface BsonRegex extends BsonValue {
    @Nonnull
    Set getOptions();

    public String getOptionsAsText();

    @Nonnull
    String getPattern();

    /**
     * Two BsonRegex are equal if their options and pattern (as text) properties are equal.
     *
     * This implies two BsonRegex that are not equals might match the same strings.
     * @param obj
     * @return
     */
    @Override
    public boolean equals(Object obj);

    /**
     * The hashCode of a BsonRegex is the hashCode of its pattern.
     *
     * @return
     */
    @Override
    public int hashCode();

    public static enum Options {
        /**
         * Usually defined as i.
         */
        CASE_INSENSITIVE('i'),
        /**
         * Usually defined as m.
         */
        MULTILINE_MATCHING('m'),
        /**
         * Usually defined as x.
         */
        VERBOSE_MODE('x'),
        /**
         * Usually defined as l, makes \w, \W, etc locale dependent.
         */
        LOCALE_DEPENDENT('i'),
        /**
         * Usually defined as s, makes . match everything.
         */
        DOTALL_MODE('s'),
        /**
         * Usually defined as u, makes \w, \W, etc match unicode.
         */
        UNICODE('u');

        private static final Logger LOGGER = LoggerFactory.getLogger(Options.class);
        private static final Comparator LEXICOGRAPHICAL_COMPARATOR = new LexicographicalComparator();

        private final char charId;

        private Options(char charId) {
            this.charId = charId;
        }

        public char getCharId() {
            return charId;
        }

        public static int patternOptionsToFlags(Set options) {
            if (options.isEmpty()) {
                return 0;
            }
            LOGGER.warn("Ignored regexp options!");
            return 0; //TODO: parse regexp options!
        }

        public static EnumSet patternFlagsToOptions(int flags) {
            if (flags == 0) {
                return EnumSet.noneOf(Options.class);
            }
            LOGGER.warn("Ignored regexp options!");
            return EnumSet.noneOf(Options.class); //TODO: parse regexp options!
        }



        public static Comparator getLexicographicalComparator() {
            return LEXICOGRAPHICAL_COMPARATOR;
        }

        private static class LexicographicalComparator implements Comparator, Serializable {

            private static final long serialVersionUID = 1L;

            @Override
            public int compare(Options o1, Options o2) {
                return o1.getCharId() - o2.getCharId();
            }
        }
    }
}