com.github.katjahahn.parser.Header Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of portex_2.12 Show documentation

Java library to parse Portable Executable files

The newest version!

/*******************************************************************************
 * Copyright 2014 Katja Hahn
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************/
package com.github.katjahahn.parser;


/**
 * Represents a header of the pe file or a header of a section.
 * 
 * @author Katja Hahn
 * 
 * @param 
 *            Key type for the header
 */
public abstract class Header implements PEModule {

    /**
     * Returns the value for the key.
     * key must not be null.
     * 
     * @param key the header key
     * @return long value for the key
     */
    public abstract long get(T key);

    /**
     * Returns the {@link StandardField} for the given key.
     * Returned field is never null.
     * 
     * @param key the header key
     * @return {@link StandardField} for the given key.
     */
    public abstract StandardField getField(T key);
}