/*
* Copyright 2008-present MongoDB, Inc.
*
* Licensed 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.
*/
// Symbol.java
package org.bson.types;
import java.io.Serializable;
Class to hold an instance of the BSON symbol type.
/**
* Class to hold an instance of the BSON symbol type.
*/
public class Symbol implements Serializable {
private static final long serialVersionUID = 1326269319883146072L;
private final String symbol;
Construct a new instance with the given symbol.
Params: - symbol – the symbol
/**
* Construct a new instance with the given symbol.
*
* @param symbol the symbol
*/
public Symbol(final String symbol) {
this.symbol = symbol;
}
Gets the symbol.
Returns: the symbol
/**
* Gets the symbol.
*
* @return the symbol
*/
public String getSymbol() {
return symbol;
}
Will compare equal to a String that is equal to the String that this holds
Params: - o – the Symbol to compare this to
Returns: true if parameter o is the same as this Symbol
/**
* Will compare equal to a String that is equal to the String that this holds
*
* @param o the Symbol to compare this to
* @return true if parameter o is the same as this Symbol
*/
@Override
public boolean equals(final Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Symbol symbol1 = (Symbol) o;
if (!symbol.equals(symbol1.symbol)) {
return false;
}
return true;
}
@Override
public int hashCode() {
return symbol.hashCode();
}
@Override
public String toString() {
return symbol;
}
}