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.wicket.markup; 018 019import org.apache.wicket.WicketRuntimeException; 020import org.apache.wicket.util.resource.IResourceStream; 021 022/** 023 * Runtime exception that is thrown when markup parsing fails. 024 * 025 * @author Jonathan Locke 026 */ 027public final class MarkupException extends WicketRuntimeException 028{ 029 private static final long serialVersionUID = 1L; 030 031 /** The markup stream that was being parsed when the exception was thrown */ 032 private transient MarkupStream markupStream; 033 034 /** 035 * Constructor 036 * 037 * @param message 038 * The problem description 039 */ 040 public MarkupException(final String message) 041 { 042 super(message); 043 markupStream = null; 044 } 045 046 /** 047 * @param resource 048 * The markup resource where this exception occurred 049 * @param message 050 * The message 051 */ 052 public MarkupException(final IResourceStream resource, final String message) 053 { 054 super(resource.toString() + ": " + message); 055 markupStream = null; 056 } 057 058 /** 059 * @param resource 060 * The markup where this exception occurred 061 * @param message 062 * The message 063 * @param cause 064 * The causing exception 065 */ 066 public MarkupException(final IResourceStream resource, final String message, 067 final Throwable cause) 068 { 069 super(resource.toString() + ": " + message, cause); 070 markupStream = null; 071 } 072 073 /** 074 * @param markupStream 075 * The markup stream where this exception occurred 076 * @param message 077 * The message 078 */ 079 public MarkupException(final MarkupStream markupStream, final String message) 080 { 081 super(message); 082 this.markupStream = markupStream; 083 } 084 085 /** 086 * @param markupStream 087 * The markup stream where this exception occurred 088 * @param message 089 * The message 090 * @param cause 091 * The causing exception 092 */ 093 public MarkupException(final MarkupStream markupStream, final String message, 094 final Throwable cause) 095 { 096 super(message, cause); 097 this.markupStream = markupStream; 098 } 099 100 /** 101 * Construct. 102 * 103 * @param markup 104 * @param message 105 * @param cause 106 */ 107 public MarkupException(final Markup markup, final String message, final Throwable cause) 108 { 109 this(new MarkupStream(markup).setCurrentIndex(markup.size() - 1), message, cause); 110 } 111 112 /** 113 * @return Returns the MarkupStream. 114 */ 115 public MarkupStream getMarkupStream() 116 { 117 return markupStream; 118 } 119 120 /** 121 * Set the markup stream which caused the exception 122 * 123 * @param markupStream 124 */ 125 public void setMarkupStream(final MarkupStream markupStream) 126 { 127 this.markupStream = markupStream; 128 } 129 130 @Override 131 public String toString() 132 { 133 return getMessage() + "\n MarkupStream: " + 134 (markupStream == null ? "[unknown]" : markupStream.toString()); 135 } 136}