1 /* 2 * Copyright (C) 2012 Google Inc. 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package com.google.caliper.api; 18 19 import static java.lang.annotation.ElementType.METHOD; 20 import static java.lang.annotation.RetentionPolicy.RUNTIME; 21 22 import java.lang.annotation.Retention; 23 import java.lang.annotation.Target; 24 25 /** 26 * Annotates a method whose return value is an object whose total memory footprint is to be 27 * measured. 28 */ 29 @Retention(RUNTIME) 30 @Target(METHOD) 31 public @interface Footprint { 32 /** 33 * Optionally ignore instances of the specified types (including subclasses) when measuring. For 34 * example, {@code @Footprint(ignore = Element.class) public Set<Element> set() {...}} would 35 * measure the size of the set while ignoring the size of the elements. 36 */ 37 Class<?>[] exclude() default {}; 38 } 39
