String.h

Go to the documentation of this file.

/*
 * 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.
 */

#ifndef _DECAF_LANG_STRING_H_
#define _DECAF_LANG_STRING_H_

#include <decaf/util/Config.h>

#include <decaf/lang/CharSequence.h>
#include <decaf/lang/Comparable.h>
#include <decaf/lang/ArrayPointer.h>

#include <string>
#include <ostream>

namespace decaf {
namespace lang {

    class Contents;
    class AbstractStringBuilder;

    class DECAF_API String: public CharSequence {
    private:

        mutable Contents* contents;

    public:

        String();

        String(const char value, int count);

        String(const String& source);

        String(const std::string& source);

        String(const char* array);

        String(const char* array, int size);

        String(const char* array, int offset, int length);

        String(const char* array, int size, int offset, int length);

        virtual ~String();

    public:

        String& operator= (const String& other);

        String& operator= (const std::string& other);

        String& operator= (const char* other);

        bool operator==(const char* other) const;
        bool operator==(const String& other) const;
        bool operator==(const std::string& other) const;

        bool operator!=(const char* other) const;
        bool operator!=(const String& other) const;
        bool operator!=(const std::string& other) const;

        bool operator< (const char* other) const;
        bool operator< (const String& other) const;
        bool operator< (const std::string& other) const;

        bool operator<=(const char* other) const;
        bool operator<=(const String& other) const;
        bool operator<=(const std::string& other) const;

        bool operator> (const char* other) const;
        bool operator> (const String& other) const;
        bool operator> (const std::string& other) const;

        bool operator>=(const char* other) const;
        bool operator>=(const String& other) const;
        bool operator>=(const std::string& other) const;

        String operator+ (const String& other) const;
        String operator+ (const std::string& other) const;
        String operator+ (const char* other) const;

        const char* c_str() const;

    public:

        String compact() const;

        int compareTo(const String& string) const;

        int compareTo(const std::string& string) const;

        int compareTo(const char* string) const;

        int compareToIgnoreCase(const String& string) const;

        int compareToIgnoreCase(const std::string& string) const;

        int compareToIgnoreCase(const char* string) const;

        String concat(const String& string) const;

        String concat(const std::string& string) const;

        String concat(const char* string) const;

        bool contains(const String& string) const;

        bool contains(const std::string& string) const;

        bool contains(const char* string) const;

        bool endsWith(const String& suffix) const;

        bool equals(const String& other) const;

        bool equals(const std::string& other) const;

        bool equals(const char* other) const;

        bool equalsIgnoreCase(const String& string) const;

        bool equalsIgnoreCase(const std::string& string) const;

        bool equalsIgnoreCase(const char* string) const;

        int findFirstOf(const String& chars) const;

        int findFirstOf(const String& chars, int start) const;

        int findFirstNotOf(const String& chars) const;

        int findFirstNotOf(const String& chars, int start) const;

        void getChars(int srcBegin, int srcEnd, char* dest, int destSize, int destBegin) const;

        int hashCode() const;

        int indexOf(char value) const;

        int indexOf(char value, int start) const;

        int indexOf(const String& string) const;

        int indexOf(const String& subString, int start) const;

        int indexOf(const std::string& string) const;

        int indexOf(const std::string& subString, int start) const;

        int indexOf(const char* string) const;

        int indexOf(const char* subString, int start) const;

        bool isEmpty() const;

        int lastIndexOf(char value) const;

        int lastIndexOf(char value, int start) const;

        int lastIndexOf(const String& string) const;

        int lastIndexOf(const String& subString, int start) const;

        int lastIndexOf(const std::string& string) const;

        int lastIndexOf(const std::string& subString, int start) const;

        int lastIndexOf(const char* string) const;

        int lastIndexOf(const char* subString, int start) const;

        bool regionMatches(int thisStart, const String& string, int start, int length) const;

        bool regionMatches(bool ignoreCase, int thisStart, const String& string, int start, int length) const;

        String replace(char oldChar, char newChar) const;

        bool startsWith(const String& prefix) const;

        bool startsWith(const String& prefix, int start) const;

        String substring(int start) const;

        String substring(int start, int end) const;

        char* toCharArray() const;

        String toLowerCase() const;

        String toUpperCase() const;

        String trim() const;

    public:

        virtual int length() const;

        virtual char charAt(int index) const;

        virtual CharSequence* subSequence(int start, int end) const;

        virtual std::string toString() const;

    public:

        static String copyValueOf(const char* data);

        static String copyValueOf(char* data, int start, int length);

        static bool isNullOrEmpty(const char*);

        static String valueOf(bool value);

        static String valueOf(char value);

        static String valueOf(float value);

        static String valueOf(double value);

        static String valueOf(short value);

        static String valueOf(int value);

        static String valueOf(long long value);

    private:

        void getChars(int start, int end, char* buffer, int index) const;

        String(Contents* content);
        String(int offset, int length, const ArrayPointer<char> content);

        friend class AbstractStringBuilder;
    };

    std::ostream& operator<<(std::ostream &out, const String& target);

    bool operator==(const std::string& left, const String& right);
    bool operator==(const char* left, const String& right);
    bool operator!=(const std::string& left, const String& right);
    bool operator!=(const char* left, const String& right);
    bool operator<=(const std::string& left, const String& right);
    bool operator<=(const char* left, const String& right);
    bool operator>=(const std::string& left, const String& right);
    bool operator>=(const char* left, const String& right);
    bool operator< (const std::string& left, const String& right);
    bool operator< (const char* left, const String& right);
    bool operator> (const std::string& left, const String& right);
    bool operator> (const char* left, const String& right);

}}

#endif /* _DECAF_LANG_STRING_H_ */