001/*
002 * ModeShape (http://www.modeshape.org)
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *       http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.modeshape.schematic.document;
017
018import org.modeshape.schematic.annotation.Immutable;
019
020/**
021 * A {@link Bson.Type#JAVASCRIPT_WITH_SCOPE JavaScript code with scope} value for use within a {@link Document BSON Object}.
022 * 
023 * @author Randall Hauch <rhauch@redhat.com> (C) 2011 Red Hat Inc.
024 */
025@Immutable
026public final class CodeWithScope extends Code {
027
028    private final Document scope;
029
030    public CodeWithScope( String code,
031                          Document scope ) {
032        super(code);
033        this.scope = scope;
034        assert this.scope != null;
035    }
036
037    public Document getScope() {
038        return scope;
039    }
040
041    @Override
042    public int hashCode() {
043        return scope.hashCode();
044    }
045
046    @Override
047    public boolean equals( Object obj ) {
048        if (obj == this) return true;
049        if (obj instanceof CodeWithScope) {
050            CodeWithScope that = (CodeWithScope)obj;
051            return this.getCode().equals(that.getCode()) && this.getScope().equals(that.getScope());
052        }
053        return false;
054    }
055
056    @Override
057    public String toString() {
058        return "CodeWithScope (" + getCode() + ':' + getScope() + ')';
059    }
060
061}