001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.common.utils;
018
019/**
020 * Identical to {@link Runnable} but the run method can throw stuff.
021 *
022 * <p>
023 * Allows you to pass in arbitrary snippets of code in fluent interfaces.
024 *
025 * <p>
026 * See <c>Assertions.<jsm>assertThrown</jsm>(Snippet)</c> for an example.
027 *
028 * <h5 class='section'>See Also:</h5><ul>
029 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem Overview</a>
030 * </ul>
031 */
032public interface Snippet {
033
034   /**
035    * Run arbitrary code and optionally throw an exception.
036    *
037    * @throws Throwable Any throwable.
038    */
039   void run() throws Throwable;
040}