001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  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,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 */
019
020package org.apache.isis.core.progmodel.facets.object.mask;
021
022import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
023import org.apache.isis.core.metamodel.facets.SingleStringValueFacet;
024import org.apache.isis.core.metamodel.interactions.ValidatingInteractionAdvisor;
025import org.apache.isis.core.progmodel.facets.object.regex.RegExFacet;
026
027/**
028 * Whether the (string) property or a parameter must correspond to a specific
029 * mask.
030 * 
031 * <p>
032 * In the standard Apache Isis Programming Model, corresponds to the
033 * <tt>@Mask</tt> annotation.
034 * 
035 * <p>
036 * TODO: not yet implemented by the framework or any viewer.
037 * 
038 * @see RegExFacet
039 */
040public interface MaskFacet extends SingleStringValueFacet, ValidatingInteractionAdvisor {
041
042    /**
043     * Whether the provided string matches the mask.
044     */
045    public boolean doesNotMatch(ObjectAdapter adapter);
046}