CodeWScope.java

/*
 * Copyright (c) 2008-2014 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.
 */

package org.bson.types;

import org.bson.BSONObject;

/**
 * Represents the CodeWScope BSON type.
 *
 * @see org.bson.BsonType#JAVASCRIPT_WITH_SCOPE
 */
public class CodeWScope extends Code {

    private final BSONObject scope;

    private static final long serialVersionUID = -6284832275113680002L;

    /**
     * Creates a new instance
     * @param code the JavaScript code
     * @param scope the scope as a document
     */
    public CodeWScope(final String code, final BSONObject scope) {
        super(code);
        this.scope = scope;
    }

    /**
     * Gets the scope for this JavaScript
     * @return a document representing the scope
     */
    public BSONObject getScope() {
        return scope;
    }

    @Override
    public boolean equals(final Object o) {
        if (o == null) {
            return false;
        }
        if (getClass() != o.getClass()) {
            return false;
        }
        CodeWScope c = (CodeWScope) o;
        return getCode().equals(c.getCode()) && scope.equals(c.scope);
    }

    @Override
    public int hashCode() {
        return getCode().hashCode() ^ scope.hashCode();
    }
}