001/**
002 * Mutable.java
003 *
004 * Copyright (c) 2004-2012, Nicole C. Tedesco.  All rights reserved.
005 *
006 * Licensed under the Apache License, Version 2.0 (the "License");
007 * you may not use this file except in compliance with the License.
008 * You may obtain a copy of the License at:
009 *
010 * http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018
019package net.sf.jaccumulator;
020
021/**
022 * Indicates "instanceof" potential mutability in an implementation
023 *
024 * @since JAccumulator 4.0
025 * @author Nicole Tedesco (<a
026 *         href="mailto:Nicole@NicoleTedesco.com">Nicole@NicoleTedesco.com</a>)
027 */
028public interface Mutable
029{
030    /**
031     * @return {@code true} if modification of the implementation is allowed and
032     *         that none of the modification functions will, in principle, throw
033     *         {@link UnsupportedOperationException
034     *         UnsupportedOperationExceptions}
035     */
036    public boolean isMutable();
037}