1 /* 2 * Copyright (C) 2016 The Android Open Source Project 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.android.tools.build.apkzlib.zip; 18 19 import javax.annotation.Nonnull; 20 21 /** 22 * An alignment rule defines how to a file should be aligned in a zip, based on its name. 23 */ 24 public interface AlignmentRule { 25 26 /** 27 * Alignment value of files that do not require alignment. 28 */ 29 int NO_ALIGNMENT = 1; 30 31 /** 32 * Obtains the alignment this rule computes for a given path. 33 * 34 * @param path the path in the zip file 35 * @return the alignment value, always greater than {@code 0}; if this rule places no 36 * restrictions on the provided path, then {@link AlignmentRule#NO_ALIGNMENT} is returned 37 */ alignment(@onnull String path)38 int alignment(@Nonnull String path); 39 } 40